add openapi changelog (#6336)

discord · Aug 2, 2023 · 0fa6238 · 0fa6238
1 parent b6f07bb
commit 0fa6238
Show file tree

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/docs/Change_Log.md b/docs/Change_Log.md
@@ -1,5 +1,16 @@
 # Change Log
 
+## Public Preview of OpenAPI 3.1 Specification
+
+#### Aug 2, 2023
+
+We're introducing an [OpenAPI 3.1 spec](https://github.com/discord/discord-api-spec) in public preview to make it easier and more reliable to develop with the HTTP API. While our current developer documentation requires manual reviews and updates, the OpenAPI spec is generated from the source code which means it better reflects the nooks, crannies, and nuances of the Discord API.
+
+> warn
+> The public preview of the OpenAPI spec is subject to breaking changes without advance notice, and should not be used within production environments. If you see something that looks incorrect or can be improved, you can [open an issue](https://github.com/discord/discord-api-spec/issues).
+
+The public spec can be found in the new [`discord-api-spec` repository on GitHub](https://github.com/discord/discord-api-spec).
+
 ## New GUILD_MEDIA channel type
 
 #### Aug 1, 2023

diff --git a/docs/topics/Community_Resources.md b/docs/topics/Community_Resources.md
@@ -62,6 +62,13 @@ Discord does not maintain official SDKs.  The following table is an inexhaustive
   - [Autocode Slash Command Builder](https://autocode.com/tools/discord/command-builder/)
   - [Bsati's Slash Command Builder](https://bsati.github.io/dc-app-command-builder/)
 
+## OpenAPI Specification
+
+> warn
+> The OpenAPI spec is currently in public preview and **is subject to breaking changes**
+
+The public preview of the [Discord HTTP API specification](https://github.com/discord/discord-api-spec) provides a standard [OpenAPI 3.1 spec](https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.1.0.md) for the HTTP API. 
+
 ## Game SDK Tools
 
 Discord Game SDK's lobby and networking layer shares similarities with other gaming platforms (i.e. Valve's Steamworks SDK). The following open source library provides developers a uniform interface for these shared features and can simplify developing for multiple platforms. Note: this library is tailored for Unity3D development.