Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
discourse/spec/requests/api/schemas/json
History
Martin Brennan 19089f21d2
DEV: Add API docs for uploads and API doc watcher (#15387) 
This commit adds API documentation for the new upload
endpoints related to direct + multipart external uploads.

Also included is a rake task which watches the files in
the spec/requests/api directory and calls a script file
(spec/regenerate_swagger_docs) whenever one changes. This
script runs rake rswag:specs:swaggerize and then copies
the openapi.yml file over to the discourse_api_docs repo
directory, and hits a script there to convert the YML to
JSON so the API docs are refreshed while the server is
still running. This makes the loop of making a doc change
and seeing it in the local server much faster.

The rake task is rake autospec:swagger
 		2021-12-23 08:40:15 +10:00
..
admin_user_list_response.json DEV: Fix several type issues with the api docs (#14016) 2021-08-12 12:25:17 -06:00
admin_user_response.json DEV: Update email responses in api docs (#15178) 2021-12-03 08:03:58 -07:00
backups_create_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
backups_list_response.json api docs example (#11997) 2021-02-08 10:09:44 -07:00
badge_create_request.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
badge_create_response.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
badge_list_response.json DEV: Remove `PostProcessed` trigger option (#13916) 2021-08-04 22:24:47 +02:00
badge_update_request.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
badge_update_response.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
category_create_request.json DEV: Update category api docs (#12017) 2021-02-09 06:27:23 -07:00
category_create_response.json FIX: `include_` serializer methods must end with ? (#14407) 2021-09-22 16:01:25 +03:00
category_list_response.json FEATURE: Return subcategories on categories endpoint (#14492) 2021-10-05 12:12:31 -06:00
category_topics_response.json FEATURE: Category setting to allow unlimited first post edits by the owner of the topic (#12690) 2021-04-14 15:54:09 +10:00
category_update_response.json FIX: `include_` serializer methods must end with ? (#14407) 2021-09-22 16:01:25 +03:00
group_add_members_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_add_members_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_members_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_remove_members_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_remove_members_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
group_response.json FEATURE: Experimental support for group membership via google auth (#14835) 2021-12-09 12:30:27 +00:00
groups_list_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
search_response.json DEV: Update api docs for search endpoint (#14181) 2021-08-30 11:25:34 -06:00
site_response.json DEV: Add chat invitation notification type (#15288) 2021-12-14 09:01:53 -06:00
success_ok_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
tag_group_create_request.json
…
tag_group_create_response.json
…
topic_create_request.json Add `embed_url` to the api docs (#14813) 2021-11-03 19:22:55 -06:00
topic_create_response.json FEATURE: Let users select flair (#13587) 2021-07-08 10:46:21 +03:00
upload_abort_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_batch_presign_multipart_parts_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_batch_presign_multipart_parts_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_complete_external_upload_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_complete_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_multipart_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_multipart_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_create_request.json
…
upload_create_response.json
…
upload_generate_presigned_put_request.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
upload_generate_presigned_put_response.json DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
user_actions_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_anonymize_response.json DEV: Document anonymize user api endpoint (#13893) 2021-07-29 17:40:41 -06:00
user_badges_response.json DEV: Document some of the badge api endpoints (#13919) 2021-08-03 06:25:12 -06:00
user_create_request.json DEV: Refactor the api docs for the user endpoint (#14377) 2021-09-20 10:04:57 -06:00
user_create_response.json DEV: Refactor the api docs for the user endpoint (#14377) 2021-09-20 10:04:57 -06:00
user_delete_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_delete_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_emails_response.json DEV: Update email responses in api docs (#15178) 2021-12-03 08:03:58 -07:00
user_get_response.json DEV: Update email responses in api docs (#15178) 2021-12-03 08:03:58 -07:00
user_password_change_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_password_reset_request.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_password_reset_response.json document api endpoints (#11958) 2021-02-03 17:12:35 -07:00
user_refresh_gravatar_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_suspend_request.json DEV: Document the user suspend api endpoint (#12179) 2021-02-23 05:58:22 -07:00
user_suspend_response.json DEV: Document the user suspend api endpoint (#12179) 2021-02-23 05:58:22 -07:00
user_update_avatar_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
user_update_email_request.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
users_public_list_response.json document user endpoints (#11894) 2021-01-29 11:27:11 -07:00