Add API Changelog and enhance OpenAPI documentation#58
Open
dev-docs-github-app-dev[bot] wants to merge 2 commits intomaintemp-testing-docs-dev/docs:mainfrom
2025-06-04-19-22-docs/update-api-reference-openapi-changestemp-testing-docs-dev/docs:2025-06-04-19-22-docs/update-api-reference-openapi-changesCopy head branch name to clipboard
Open
Add API Changelog and enhance OpenAPI documentation#58dev-docs-github-app-dev[bot] wants to merge 2 commits intomaintemp-testing-docs-dev/docs:mainfrom 2025-06-04-19-22-docs/update-api-reference-openapi-changestemp-testing-docs-dev/docs:2025-06-04-19-22-docs/update-api-reference-openapi-changesCopy head branch name to clipboard
dev-docs-github-app-dev[bot] wants to merge 2 commits intomaintemp-testing-docs-dev/docs:mainfrom
2025-06-04-19-22-docs/update-api-reference-openapi-changestemp-testing-docs-dev/docs:2025-06-04-19-22-docs/update-api-reference-openapi-changesCopy head branch name to clipboard
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
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.
This PR introduces a comprehensive API changelog and enhances the OpenAPI documentation. The new changelog (api-changelog.mdx) provides detailed tracking of API changes, including recent updates from January 2025 and October 2024, with migration guidelines and breaking changes documentation. The OpenAPI documentation (openapi.mdx) has been expanded to include detailed information about recent platform updates, new integrations, and workflow system enhancements. These changes improve documentation clarity and help developers better understand API evolution and available features.