diff --git a/PRERELEASE.md b/PRERELEASE.md index 697c437a..3f2b3985 100644 --- a/PRERELEASE.md +++ b/PRERELEASE.md @@ -2,3 +2,9 @@ ## Changelog > Note: This changelog only includes the changes for the pre-release versions of Azure API Center for Visual Studio Code. For the changelog of stable versions, please refer to the [Changelog of Azure API Center for Visual Studio Code](https://github.com/microsoft/vscode-azureapicenter/blob/main/CHANGELOG.md). + +### July 16, 2024 + +* Generating Markdown documentation for an API: We have added a new command in the tree view of API definition called "Generate Markdown" to allow developers to easily generate markdown documentation. +* Generating Open API specification from an API code: Developers now can right click on any API code and invoke the "Generate API Documentation" menu (under "Copilot" menu) to generate Open API specification document when provided with API code. +* Deprecation of Azure account extension diff --git a/README.md b/README.md index b094b5db..054e9d27 100644 --- a/README.md +++ b/README.md @@ -14,6 +14,10 @@ Ensure that new API versions don't break API consumers with breaking change dete ![Breaking Change Detection](./media/breaking-change.png) +[pre-release] Generate Open API specification file from API code. + +![Generate Open API specification](./media/generate-api-documentation.gif) + ### Discover Find the right API, fast from your organization's hand-crafted API catalog with API Center. @@ -31,6 +35,10 @@ Explore API requests and responses with automated .http file generation powered ![generate-http-file](./media/generate-http-file.png) +[pre-release] Generate markdown documentation for an API definition. + +![Generate Markdown](./media/generate-markdown.png) + ### Consume Generate API SDK clients for your favorite language including JavaScript, TypeScript, .NET, Python, Java, and more, powered by the same [Microsoft Kiota](https://learn.microsoft.com/en-us/openapi/kiota/overview) engine that generates SDKs for Microsoft Graph, GitHub, and more. diff --git a/media/generate-api-documentation.gif b/media/generate-api-documentation.gif new file mode 100644 index 00000000..2aa57f96 Binary files /dev/null and b/media/generate-api-documentation.gif differ diff --git a/media/generate-markdown.png b/media/generate-markdown.png new file mode 100644 index 00000000..ca90fd5e Binary files /dev/null and b/media/generate-markdown.png differ