github-mirror/discourse
2
0
Fork 0
mirror of https://github.com/discourse/discourse.git synced 2025-01-30 16:14:15 +08:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

DEV: Document notifications and tags api endpoints

Browse Source 
Added some more specs that will be used to auto generate the api docs.
This commit is contained in:
Blake Erickson 2020-08-07 14:28:47 -06:00
parent 31e9e0c41b
commit 33982c0c9e
2 changed files with 434 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

84
spec/requests/api/notifications_spec.rb Normal file
View File

@ -0,0 +1,84 @@
# frozen_string_literal: true
require 'swagger_helper'
describe 'notifications' do
let(:admin) { Fabricate(:admin) }
let!(:notification) { Fabricate(:notification, user: admin) }
before do
Jobs.run_immediately!
sign_in(admin)
end
path '/notifications.json' do
get 'Get the notifications that belong to the current user' do
tags 'Notifications'
produces 'application/json'
response '200', 'notifications' do
schema type: :object, properties: {
notifications: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :integer },
user_id: { type: :integer },
notification_type: { type: :integer },
read: { type: :boolean },
created_at: { type: :string },
post_number: { type: :string, nullable: true },
topic_id: { type: :integer, nullable: true },
slug: { type: :string, nullable: true },
data: {
type: :object,
properties: {
badge_id: { type: :integer },
badge_name: { type: :string },
badge_slug: { type: :string },
badge_title: { type: :boolean },
username: { type: :string },
}
},
}
},
},
total_rows_notifications: { type: :integer },
seen_notification_id: { type: :integer },
load_more_notifications: { type: :string },
}
run_test!
end
end
end
path '/notifications/mark-read.json' do
put 'Mark notifications as read' do
tags 'Notifications'
consumes 'application/json'
parameter name: :notification, in: :body, schema: {
type: :object,
properties: {
id: {
type: :integer,
description: '(optional) Leave off to mark all notifications as read'
}
},
}
produces 'application/json'
response '200', 'notifications marked read' do
schema type: :object, properties: {
success: { type: :string },
}
run_test!
end
end
end
end

350
spec/requests/api/tags_spec.rb Normal file
View File

@ -0,0 +1,350 @@
# frozen_string_literal: true
require 'swagger_helper'
describe 'tags' do
let(:admin) { Fabricate(:admin) }
let!(:tag) { Fabricate(:tag, name: 'foo') }
let!(:tag_group) { Fabricate(:tag_group, tags: [tag]) }
before do
SiteSetting.tagging_enabled = true
Jobs.run_immediately!
sign_in(admin)
end
path '/tag_groups.json' do
get 'Get a list of tag groups' do
tags 'Tags'
produces 'application/json'
response '200', 'tags' do
schema type: :object, properties: {
tag_groups: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :integer },
name: { type: :string },
tag_names: {
type: :array,
items: {
},
},
parent_tag_name: {
type: :array,
items: {
},
},
one_per_topic: { type: :boolean },
permissions: {
type: :object,
properties: {
staff: { type: :integer },
}
},
}
},
},
}
run_test!
end
end
end
path '/tag_groups.json' do
post 'Creates a tag group' do
tags 'Tags'
consumes 'application/json'
parameter name: :post_body, in: :body, schema: {
type: :object,
properties: {
name: { type: :string }
},
required: [ 'name' ]
}
produces 'application/json'
response '200', 'tag group created' do
schema type: :object, properties: {
tag_group: {
type: :object,
properties: {
id: { type: :integer },
name: { type: :string },
tag_names: {
type: :array,
items: {
},
},
parent_tag_name: {
type: :array,
items: {
},
},
one_per_topic: { type: :boolean },
permissions: {
type: :object,
properties: {
everyone: { type: :integer },
}
},
}
},
}
let(:post_body) { { name: 'todo' } }
run_test!
end
end
end
path '/tag_groups/{id}.json' do
get 'Get a single tag group' do
tags 'Tags'
consumes 'application/json'
parameter name: :id, in: :path, schema: { type: :string }
produces 'application/json'
response '200', 'notifications' do
schema type: :object, properties: {
tag_group: {
type: :object,
properties: {
id: { type: :integer },
name: { type: :string },
tag_names: {
type: :array,
items: {
},
},
parent_tag_name: {
type: :array,
items: {
},
},
one_per_topic: { type: :boolean },
permissions: {
type: :object,
properties: {
everyone: { type: :integer },
}
},
}
},
}
let(:id) { tag_group.id }
run_test!
end
end
end
path '/tag_groups/{id}.json' do
put 'Update tag group' do
tags 'Tags'
consumes 'application/json'
parameter name: :id, in: :path, schema: { type: :string }
parameter name: :put_body, in: :body, schema: {
type: :object,
properties: {
name: { type: :string }
}
}
produces 'application/json'
response '200', 'Tag group updated' do
schema type: :object, properties: {
success: { type: :string },
tag_group: {
type: :object,
properties: {
id: { type: :integer },
name: { type: :string },
tag_names: {
type: :array,
items: {
},
},
parent_tag_name: {
type: :array,
items: {
},
},
one_per_topic: { type: :boolean },
permissions: {
type: :object,
properties: {
everyone: { type: :integer },
}
},
}
},
}
let(:id) { tag_group.id }
let(:put_body) { { name: 'todo2' } }
run_test!
end
end
end
path '/tags.json' do
get 'Get a list of tags' do
tags 'Tags'
produces 'application/json'
response '200', 'notifications' do
schema type: :object, properties: {
tags: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :string },
text: { type: :string },
count: { type: :integer },
pm_count: { type: :integer },
target_tag: { type: :string, nullable: true },
}
},
},
extras: {
type: :object,
properties: {
categories: {
type: :array,
items: {
},
},
}
},
}
run_test!
end
end
end
path '/tags/{name}.json' do
get 'Get a specific tag' do
tags 'Tags'
parameter name: :name, in: :path, schema: { type: :string }
produces 'application/json'
response '200', 'notifications' do
schema type: :object, properties: {
users: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :integer },
username: { type: :string },
name: { type: :string, nullable: true },
avatar_template: { type: :string },
}
},
},
primary_groups: {
type: :array,
items: {
},
},
topic_list: {
type: :object,
properties: {
can_create_topic: { type: :boolean },
draft: { type: :string, nullable: true },
draft_key: { type: :string },
draft_sequence: { type: :integer },
per_page: { type: :integer },
tags: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :integer },
name: { type: :string },
topic_count: { type: :integer },
staff: { type: :boolean },
}
},
},
topics: {
type: :array,
items: {
type: :object,
properties: {
id: { type: :integer },
title: { type: :string },
fancy_title: { type: :string },
slug: { type: :string },
posts_count: { type: :integer },
reply_count: { type: :integer },
highest_post_number: { type: :integer },
image_url: { type: :string, nullable: true },
created_at: { type: :string },
last_posted_at: { type: :string },
bumped: { type: :boolean },
bumped_at: { type: :string },
archetype: { type: :string },
unseen: { type: :boolean },
last_read_post_number: { type: :integer },
unread: { type: :integer },
new_posts: { type: :integer },
pinned: { type: :boolean },
unpinned: { type: :string, nullable: true },
visible: { type: :boolean },
closed: { type: :boolean },
archived: { type: :boolean },
notification_level: { type: :integer },
bookmarked: { type: :boolean },
liked: { type: :boolean },
tags: {
type: :array,
items: {
},
},
views: { type: :integer },
like_count: { type: :integer },
has_summary: { type: :boolean },
last_poster_username: { type: :string },
category_id: { type: :integer },
pinned_globally: { type: :boolean },
featured_link: { type: :string, nullable: true },
posters: {
type: :array,
items: {
type: :object,
properties: {
extras: { type: :string },
description: { type: :string },
user_id: { type: :integer },
primary_group_id: { type: :string, nullable: true },
}
},
},
}
},
},
}
},
}
let(:name) { tag.name }
run_test!
end
end
end
end