discourse/spec/requests/api
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
..
schemas DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
shared document user endpoints (#11894) 2021-01-29 11:27:11 -07:00
backups_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
badges_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
categories_spec.rb DEV: Add include_subcategories param to api docs (#14534) 2021-10-06 12:34:03 -06:00
groups_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
invites_spec.rb DEV: Update invite API docs expires_at default (#14550) 2021-10-07 12:41:04 +01:00
notifications_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
posts_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
private_messages_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
search_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
site_spec.rb DEV: Add site.json to api docs (#14249) 2021-09-07 10:36:05 -06:00
tags_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
topics_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
uploads_spec.rb DEV: Add API docs for uploads and API doc watcher (#15387) 2021-12-23 08:40:15 +10:00
user_badges_spec.rb DEV: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00
users_spec.rb DEV: Update email responses in api docs (#15178) 2021-12-03 08:03:58 -07:00