discourse/spec/requests/api
Blake Erickson ee7809e8a8
DEV: Add missing operationIds to the api docs (#14235)
From the openapi spec:

 https://spec.openapis.org/oas/latest.html#fixed-fields-7

each endpoint needs to have an `operationId`:

> Unique string used to identify the operation. The id MUST be unique
> among all operations described in the API. The operationId value is
> case-sensitive. Tools and libraries MAY use the operationId to uniquely
> identify an operation, therefore, it is RECOMMENDED to follow common
> programming naming conventions.

Running the linter on our openapi.json file with this command:

`npx @redocly/openapi-cli lint openapi.json`

produced the following warning on all of our endpoints:

> Operation object should contain `operationId` field

This commit resolves these warnings by adding an operationId field to
each endpoint.
2021-09-03 07:39:29 -06:00
..
schemas DEV: Update api docs for search endpoint (#14181) 2021-08-30 11:25:34 -06: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 missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -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: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06: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
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 missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06: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: Add missing operationIds to the api docs (#14235) 2021-09-03 07:39:29 -06:00