From 9a0fa248a8110f390595c0ee5694566f916d362d Mon Sep 17 00:00:00 2001 From: Shay Date: Wed, 2 Aug 2023 14:01:17 -0700 Subject: [PATCH] update readme --- README.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 8f8b418..f957abd 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,6 @@ # 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). +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)). ## Usage @@ -10,9 +8,15 @@ This repository contains the [OpenAPI specification](https://spec.openapis.org/o 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. +- [`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). \ No newline at end of file