The following commit adds a comprehensive OpenAPI specification (open… #32841
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…api.yaml): This commit introduces an OpenAPI 3.0.0 specification file (openapi.yaml) that documents the Discourse API. The specification includes: - Paths and operations derived from core application routes and plugins (Automation, Chat, Narrative Bot, Styleguide). - Reusable schemas for common data structures (User, Post, Topic, Category, Group, etc.) in the components section. - API metadata including title, version, description, and contact information. - Definitions for request and response bodies, referencing the reusable schemas. - A global API key security scheme. This initial version provides a broad overview of the API surface. Further refinements to request/response schema details and more specific security configurations can be made in subsequent iterations.
|
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
…api.yaml):
This commit introduces an OpenAPI 3.0.0 specification file (openapi.yaml) that documents the Discourse API.
The specification includes:
This initial version provides a broad overview of the API surface. Further refinements to request/response schema details and more specific security configurations can be made in subsequent iterations.