discord-api-spec
discord-api-spec copied to clipboard
1,797 vacuum warnings
https://github.com/daveshanley/vacuum
The 28 errors might not be fixable...
% vacuum lint -d api.yaml | grep error
..
api.yaml:2342:3 | error | paths are ambiguous with one another: `/guilds/templates/{code}` and `/guilds/{guild_id}/audit-logs` | no-ambiguous-paths | Operations | $.paths['/guilds/{guild_id}/audit-logs']
api.yaml:2515:3 | error | paths are ambiguous with one another: `/guilds/templates/{code}` and `/guilds/{guild_id}/bans` | no-ambiguous-paths | Operations | $.paths['/guilds/{guild_id}/bans']
api.yaml:2616:3 | error | paths are ambiguous with one another: `/guilds/templates/{code}` and `/guilds/{guild_id}/bulk-ban` | no-ambiguous-paths | Operations | $.paths['/guilds/{guild_id}/bulk-ban']
api.yaml:2657:3 | error | paths are ambiguous with one another: `/guilds/templates/{code}` and `/guilds/{guild_id}/channels` | no-ambiguous-paths | Operations | $.paths['/guilds/{guild_id}/channels']
...
The 1,797 warnings are fixable
% vacuum lint -d api.yaml | grep warning | head -30
api.yaml:1:1 | warning | circular reference detected from #/components/schemas/ErrorDetails | circular-references | Schemas | ClientErrorResponse -> ErrorResponse -> ErrorDetails -> Erro...
api.yaml:16:3 | warning | path segments `@me` do not use kebab-case | paths-kebab-case | Operations | $.paths['/applications/@me']
api.yaml:17:5 | warning | operation method `GET` at path `/applications/@me` is missing a `summary` | operation-description | Descriptions | $.paths['/applications/@me'].get
api.yaml:17:5 | warning | tags for `GET` operation are missing | operation-tags | Tags | $.paths['/applications/@me'].get
api.yaml:17:5 | warning | operation method `GET` at path `/applications/@me` is missing a `description` | operation-description | Descriptions | $.paths['/applications/@me'].get api.yaml:23:13 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/@me'].get.responses['200'].content['a...
api.yaml:30:5 | warning | operation method `PATCH` at path `/applications/@me` is missing a `description` | operation-description | Descriptions | $.paths['/applications/@me'].patch
api.yaml:30:5 | warning | operation method `PATCH` at path `/applications/@me` is missing a `summary` | operation-description | Descriptions | $.paths['/applications/@me'].patch
api.yaml:30:5 | warning | tags for `PATCH` operation are missing | operation-tags | Tags | $.paths['/applications/@me'].patch
api.yaml:32:7 | warning | operation method `PATCH` `requestBody` at path `/applications/@me` is missing a `description` | operation-description | Descriptions | $.paths['/applications/@me'].patch.requestBody
api.yaml:34:11 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/@me'].patch.requestBody.content['appl...
api.yaml:42:13 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/@me'].patch.responses['200'].content[...
api.yaml:51:7 | warning | the parameter `application_id` does not contain a description | oas3-parameter-description | Descriptions | $.paths['/applications/{application_id}'].top.parameters
api.yaml:56:5 | warning | operation method `GET` at path `/applications/{application_id}` is missing a `description` | operation-description | Descriptions | $.paths['/applications/{application_id}'].get
api.yaml:56:5 | warning | tags for `GET` operation are missing | operation-tags | Tags | $.paths['/applications/{application_id}'].get
api.yaml:56:5 | warning | operation method `GET` at path `/applications/{application_id}` is missing a `summary` | operation-description | Descriptions | $.paths['/applications/{application_id}'].get
api.yaml:62:13 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/{application_id}'].get.responses['200...
api.yaml:69:5 | warning | tags for `PATCH` operation are missing | operation-tags | Tags | $.paths['/applications/{application_id}'].patch
api.yaml:69:5 | warning | operation method `PATCH` at path `/applications/{application_id}` is missing a `summary` | operation-description | Descriptions | $.paths['/applications/{application_id}'].patch
api.yaml:69:5 | warning | operation method `PATCH` at path `/applications/{application_id}` is missing a `description` | operation-description | Descriptions | $.paths['/applications/{application_id}'].patch
api.yaml:71:7 | warning | operation method `PATCH` `requestBody` at path `/applications/{application_id}` ... | operation-description | Descriptions | $.paths['/applications/{application_id}'].patch.requestBody
api.yaml:73:11 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/{application_id}'].patch.requestBody....
api.yaml:81:13 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/{application_id}'].patch.responses['2...
api.yaml:90:7 | warning | the parameter `application_id` does not contain a description | oas3-parameter-description | Descriptions | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:95:7 | warning | the parameter `instance_id` does not contain a description | oas3-parameter-description | Descriptions | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:101:5 | warning | operation method `GET` at path `/applications/{application_id}/activity-instance... | operation-description | Descriptions | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:101:5 | warning | operation method `GET` at path `/applications/{application_id}/activity-instance... | operation-description | Descriptions | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:101:5 | warning | tags for `GET` operation are missing | operation-tags | Tags | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:107:13 | warning | media type is missing `examples` or `example` | oas3-missing-example | Examples | $.paths['/applications/{application_id}/activity-instances/{...
api.yaml:116:7 | warning | the parameter `application_id` does not contain a description | oas3-parameter-description | Descriptions | $.paths['/applications/{application_id}/attachment'].top.par...