Skip to content

Commit 5501546

Browse files
Merge pull request #283280 from dlepow/vspre
[APIC] Pre-release VSCode extension features
2 parents a98dd01 + c138e0a commit 5501546

File tree

1 file changed

+9
-3
lines changed

1 file changed

+9
-3
lines changed

articles/api-center/use-vscode-extension.md

Lines changed: 9 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Build, discover, try, and consume APIs from your Azure API center u
44
author: dlepow
55
ms.service: azure-api-center
66
ms.topic: how-to
7-
ms.date: 07/15/2024
7+
ms.date: 08/01/2024
88
ms.author: danlep
99
ms.custom:
1010
# Customer intent: As a developer, I want to use my Visual Studio Code environment to build, discover, try, and consume APIs in my organization's API center.
@@ -33,6 +33,9 @@ To build, discover, try, and consume APIs in your [API center](overview.md), you
3333
* [Visual Studio Code](https://code.visualstudio.com/)
3434

3535
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
36+
37+
> [!NOTE]
38+
> Where noted, certain features are available only in the extension's pre-release version. When installing the extension from the [Visual Studio Code Marketplace](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center&ssr=false#overview), you can choose to install the release version or a pre-release version. Switch between the two versions at any time by using the extension's **Manage** button context menu in the Extensions view.
3639
3740
The following Visual Studio Code extensions are optional and needed only for certain scenarios as indicated:
3841

@@ -86,7 +89,10 @@ Visual Studio Code will open a diff view between the two API specifications. Any
8689

8790
## Generate OpenAPI specification file from API code
8891

89-
Use the power of GitHub Copilot with the Azure API Center extension for Visual Studio Code to create an OpenAPI specification file from your API code. Right click on the API code, select **Copilot** from the options, and select **Generate API documentation**. This will create an OpenAPI specification file.
92+
Use the power of GitHub Copilot with the Azure API Center extension for Visual Studio Code to create an OpenAPI specification file from your API code. Right-click on the API code, select **Copilot** from the options, and select **Generate API documentation**. This will create an OpenAPI specification file.
93+
94+
> [!NOTE]
95+
> This feature is available in the pre-release version of the API Center extension.
9096
9197
:::image type="content" source="media/use-vscode-extension/generate-api-documentation.gif" alt-text="Animation showing how to use GitHub Copilot to generate an OpenAPI spec from code." lightbox="media/use-vscode-extension/generate-api-documentation.gif":::
9298

@@ -115,7 +121,7 @@ You can view the documentation for an API definition in your API center and try
115121
> Depending on the API, you might need to provide authorization credentials or an API key to try the API.
116122
117123
> [!TIP]
118-
> You can also use the extension to generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
124+
> Using the pre-release version of the extension, you can generate API documentation in Markdown, a format that's easy to maintain and share with end users. Right-click on the definition, and select **Generate Markdown**.
119125
120126
## Generate HTTP file
121127

0 commit comments

Comments
 (0)