main - remote-2023-08-02T21:48:05 now-2023-08-03T03:27:59

LICENSE

@@ -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.

README.md

@@ -0,0 +1,24 @@
+# Discord OpenAPI Specification
+
+This repository contains the public preview of the [OpenAPI 3.1 specification](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) for [Discord's API](https://discord.com/developers/docs/reference). Currently, the spec is only available for the most recent Discord API version ([v10](https://discord.com/developers/docs/reference#api-versioning-api-versions)).
+
+> ⚠️ The public preview of the OpenAPI spec is subject to breaking changes without advance notice, and should not be used within production environments.
+
+## 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.
+- [`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** or 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).
+
+## Contributing
+
+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).