You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-center/build-register-apis-vscode-extension.md
+33-4Lines changed: 33 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: API developers can use the Azure API Center extension for Visual St
4
4
author: dlepow
5
5
ms.service: azure-api-center
6
6
ms.topic: how-to
7
-
ms.date: 10/16/2024
7
+
ms.date: 11/08/2024
8
8
ms.author: danlep
9
9
ms.collection: ce-skilling-ai-copilot
10
10
ms.custom:
@@ -16,7 +16,8 @@ ms.custom:
16
16
API developers in your organization can build and register APIs in your [API center](overview.md) inventory by using the Azure API Center extension for Visual Studio Code. API developers can:
17
17
18
18
* Add an existing API to an API center as a one-time operation, or integrate a development pipeline to register APIs as part of a CI/CD workflow.
19
-
* Generate OpenAPI specification files from API code using GitHub Copilot, and register the API to an API center.
19
+
* Use GitHub Copilot to generate new OpenAPI specs from API code.
20
+
* Use natural language prompts with the API Center plugin for GitHub Copilot for Azure to create new OpenAPI specs.
20
21
21
22
API developers can also take advantage of features in the extension to [discover and consume APIs](discover-apis-vscode-extension.md) in the API center and ensure [API governance](govern-apis-vscode-extension.md).
22
23
@@ -27,6 +28,7 @@ The following Visual Studio Code extensions are needed for the specified scenari
27
28
*[GitHub Actions](https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-github-actions) - to register APIs using a CI/CD pipeline with GitHub Actions
28
29
*[Azure Pipelines](https://marketplace.visualstudio.com/items?itemName=ms-azure-devops.azure-pipelines) - to register APIs using a CI/CD pipeline with Azure Pipelines
29
30
*[GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=GitHub.copilot) - to generate OpenAPI specification files from API code
31
+
*[GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) - to generate OpenAPI specification files using the Azure API Center Plugin for GitHub Copilot for Azure
@@ -51,9 +53,9 @@ The following steps register an API in your API center with a CI/CD pipeline. Wi
51
53
52
54
Learn more about setting up a [GitHub Actions workflow](register-apis-github-actions.md) to register APIs with your API center.
53
55
54
-
## Generate OpenAPI specification file from API code
56
+
## Generate OpenAPI spec from API code
55
57
56
-
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**. GitHub Copilot creates an OpenAPI specification file.
58
+
Use the power of [GitHub Copilot](https://marketplace.visualstudio.com/items?itemName=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**. GitHub Copilot creates an OpenAPI specification file.
57
59
58
60
> [!NOTE]
59
61
> This feature is available in the pre-release version of the API Center extension.
@@ -62,6 +64,33 @@ Use the power of GitHub Copilot with the Azure API Center extension for Visual S
62
64
63
65
After generating the OpenAPI specification file and checking for accuracy, you can register the API with your API center using the **Azure API Center: Register API** command.
64
66
67
+
## Generate OpenAPI spec using natural language prompts
68
+
69
+
The API Center plugin for [GitHub Copilot for Azure](https://marketplace.visualstudio.com/items?itemName=ms-azuretools.vscode-azure-github-copilot) helps you design new APIs starting from natural language prompts. With AI assistance, quickly generate an OpenAPI spec for API development that complies with your organization's standards.
70
+
71
+
> [!NOTE]
72
+
> This feature is available in the pre-release version of the API Center extension.
73
+
74
+
1. If desired, set an active API style guide. Use the **Ctrl+Shift+P** keyboard shortcut to open the Command Palette. Type **Azure API Center: Set API Style Guide**, make a selection, and hit **Enter**.
75
+
76
+
If no style guide is set, the default `spectral:oas` ruleset is used.
77
+
1. In the chat panel, make a request in natural language to the `@azure` agent to describe what the API does. Example:
78
+
79
+
```vscode
80
+
@azure Generate OpenAPI spec: An API that allows customers to pay for an order using various payment methods such as cash, checks, credit cards, and debit cards.
81
+
```
82
+
83
+
The agent responds with an OpenAPI specification document.
84
+
85
+
:::image type="content" source="media/build-register-apis-vscode-extension/generate-api-specification.png" alt-text="Screenshot showing how to use @azure extension to generate an OpenAPI spec from a prompt.":::
86
+
87
+
88
+
1. Review the generated output for accuracy and compliance with your API style guide. Refine the prompt if needed to regenerate.
89
+
90
+
> [!TIP]
91
+
> Effective prompts focus on an API's business requirements rather than implementation details. Shorter prompts sometimes work better than longer ones.
92
+
1. When it meets your requirements, save the generated OpenAPI specification to a file.
93
+
1. Register the API with your API center. Select **Register your API in API Center** button in the chat panel, or select **Azure API Center: Register API** from the Command Palette, and follow the prompts.
Copy file name to clipboardExpand all lines: articles/cost-management-billing/manage/direct-ea-billing-invoice-documents.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -120,11 +120,11 @@ The transactions file is a CSV file that includes the same information as the in
120
120
| Extended Amount | The quantity multiplied by the unit price. |
121
121
| Commitment Usage | The amount of monetary commitment that has been used. |
122
122
| Net Amount | The extended amount minus the commitment usage. |
123
-
| Tax Rate | The tax rate applicable to the product based on the country of billing. |
123
+
| Tax Rate | The tax rate applicable to the product based on the country/region of billing. |
124
124
| Tax Amount | The net amount multiplied by tax rate. |
125
125
| Total | The sum of the net amount and tax amount. |
126
126
| Is Third Party | Indicates whether the product or service is a third-party product. |
127
127
128
128
## Related content
129
129
130
-
- Learn how to download your Direct EA billing invoice documents at [View your Azure usage summary details and download reports for direct EA enrollments](direct-ea-azure-usage-charges-invoices.md).
130
+
- Learn how to download your Direct EA billing invoice documents at [View your Azure usage summary details and download reports for direct EA enrollments](direct-ea-azure-usage-charges-invoices.md).
0 commit comments