Cynosphere/discord-api-spec
1
0
Fork 0
mirror of https://github.com/discord/discord-api-spec.git synced 2024-12-22 00:21:23 -05:00
Code Issues Projects Releases Packages Wiki Activity

init

Browse source
This commit is contained in:
Shay 2023-07-13 15:04:25 -07:00
commit 5b7a1b77a6
2 changed files with 27 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
LICENSE Normal file
View file

@ -0,0 +1,9 @@
MIT License
Copyright 2023 Discord
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

18
README.md Normal file
View file

@ -0,0 +1,18 @@
# Discord OpenAPI Specification
This repository contains the [OpenAPI specification](https://spec.openapis.org/oas/latest.html) for [Discord's API](https://discord.com/developers/docs/reference). Currently, the spec is only for the most recent Discord API version ([v10](https://discord.com/developers/docs/reference#api-versioning-api-versions)).
> ⚙️ OpenAPI spec contents are automatically generated, and therefore we do not allow public contributions to this repo. For bug fixes or improvements, you can [open an issue](https://github.com/discord/discord-api-spec/issues).
## Usage
### Spec Files
Two versions of the spec are included—the standard spec and the preview spec:
- [`openapi.json`](specs/openapi.json) is the standard spec that contains the stable, public API. If you're using the spec in a production environment, you should use this spec.
- [`openapi_preview.json`](specs/openapi_preview.json) is the preview spec which contains unstable and/or experimental API features. **This should not be considered stable** nor used in production environments.
### Integrating with Postman
To use the spec with Postman, you can view the [public collection](https://www.postman.com/discord-api).