discord-api-spec
discord-api-spec copied to clipboard
discord
OpenAPI specification for Discord APIs
See - https://discord.com/developers/docs/monetization/entitlements - https://discord.com/developers/docs/monetization/skus - https://discord.com/developers/docs/game-sdk/store
All(?) endpoints are subject to ratelimiting, and so are able to return 429 responses. when a 429 response is sent, the json body of the response doesnt match the schema...
To avoid hitting ratelimits, a library needs to be able to guess, with some degree of confidence, which bucket a request will fall into before making the request. Most libraries...
Add a way to identify the Schema of operation responses. For example the `get_channel` operation, when successfull, can return 1 of 4 different schemas. If you take a look at...
A number of endpoints support the `X-Audit-Log-Reason` header, but this isnt included in the spec anywhere. I think that adding it to the parameters of all operations which support it...
The openapi.json file usually works with Swagger UI. Then, I have tried for using Swagger UI with Discord API Spec, but Discord API Spec's openapi.json doesn't have "tags" attr, so...
Currently, the schema doesn't include any documentation at all. This would be a very nice addition for autogenerated documentation and code.
https://github.com/discord/discord-api-spec/blob/4649f52a83726fe78745cd3ac8e891f54ce1df86/specs/openapi.json#L26868-L26876 As we know colors can be from 0 to #FFFFFF So definetly not the whole int32 The same with other properties like position which cant be negative Code https://github.com/discord/discord-api-spec/blob/4649f52a83726fe78745cd3ac8e891f54ce1df86/specs/openapi.json#L27704-L27709
According to the specification, the following fields are required on an audit log entry: https://github.com/discord/discord-api-spec/blob/871c89864629d306ab97158263a99390ec2fa5db/specs/openapi.json#L12219-L12222 However, [the documentation](https://discord.com/developers/docs/resources/audit-log#audit-log-entry-object-audit-log-entry-structure) states that the following are required: - `target_id` - `user_id` - `id`...
Currently, the create message route is... kinda sucky: https://github.com/discord/discord-api-spec/blob/bab7bf1988b7a49fb8f45fae936126122d0a25e4/specs/openapi.json#L4496-L4537 This could be better expressed as: ```json "patternProperties": { "^files\\[[0-9]+\\]$": { "type": "string", "contentEncoding": "binary" } } ``` using [`patternProperties`](https://json-schema.org/draft/2020-12/json-schema-core.html#name-patternproperties).