Skip to content

Commit 296ff48

Browse files
committed
review comments
1 parent a5f8406 commit 296ff48

File tree

2 files changed

+16
-29
lines changed

2 files changed

+16
-29
lines changed

articles/api-center/enable-managed-api-analysis-linting.md

Lines changed: 16 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Managed API linting and analysis - Azure API Center
33
description: Enable managed linting of API definitions in your API center to analyze compliance of APIs with the organization's API style guide.
44
ms.service: azure-api-center
55
ms.topic: how-to
6-
ms.date: 08/22/2024
6+
ms.date: 08/23/2024
77
ms.author: danlep
88
author: dlepow
99
ms.custom:
@@ -37,18 +37,18 @@ In this scenario:
3737

3838
* The following Visual Studio Code extensions:
3939
* [Azure API Center extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=apidev.azure-api-center)
40-
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)
4140

42-
> [!NOTE]
43-
> Enable managed API analysis using the API Center extension's pre-release version. When installing the extension, choose the pre-release version. Switch between release and pre-release versions any time via the extension's **Manage** button in the Extensions view.
41+
> [!IMPORTANT]
42+
> Enable managed API analysis using the API Center extension's pre-release version. When installing the extension, choose the pre-release version. Switch between release and pre-release versions any time via the extension's **Manage** button in the Extensions view.
43+
* [Spectral extension for Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=stoplight.spectral)
4444

4545
## Enable API analysis using Visual Studio Code
4646

4747
To enable API analysis using the default linting ruleset:
4848

49-
1. In Visual Studio Code, open a folder that you will use to manage rulesets for Azure API Center.
49+
1. In Visual Studio Code, open a folder that you'll use to manage rulesets for Azure API Center.
5050
1. Select the Azure API Center icon from the Activity Bar.
51-
1. In the Explorer pane, expand the API center resource in which to enable API analysis.
51+
1. In the API Center pane, expand the API center resource in which to enable API analysis.
5252
1. Right-click **Rules** and select **Enable API Analysis**.
5353

5454
:::image type="content" source="media/enable-managed-api-analysis-linting/enable-analysis-visual-studio-code.png" alt-text="Screenshot of enabling API linting and analysis in Visual Studio Code.":::
@@ -62,34 +62,21 @@ With analysis enabled, the linting engine analyzes API definitions in your API c
6262

6363
## View API analysis reports
6464

65-
View the analysis reports for your API definitions in the Azure portal. After an API definition is analyzed, the report lists errors, warnings, and information based on the configured API style guide.
66-
67-
In the portal, you can also view a summary of analysis reports for all API definitions in your API center.
68-
69-
### Analysis report for an API definition
70-
71-
To view the analysis report for an API definition in your API center:
72-
73-
1. In the portal, navigate to an API version in your API center where you have added or updated an API definition.
74-
1. In the left menu, under **Details**, select **Definitions**.
75-
1. Select the API definition.
76-
1. Select the **Analysis** tab.
77-
:::image type="content" source="media/enable-api-analysis-linting/analyze-api-definition.png" alt-text="Screenshot of Analysis tab for API definition in the portal." :::
65+
View an analysis summary and the analysis reports for your API definitions in the Azure portal. After API definitions are analyzed, the reports list errors, warnings, and information based on the configured API style guide.
7866

79-
The **API Analysis Report** opens, and it displays the API definition and errors, warnings, and information based on the configured API style guide. The following screenshot shows an example of an API analysis report.
80-
81-
:::image type="content" source="media/enable-api-analysis-linting/api-analysis-report.png" alt-text="Screenshot of an API analysis report in the portal." lightbox="media/enable-api-analysis-linting/api-analysis-report.png":::
82-
83-
### API analysis summary
84-
85-
To view a summary of analysis reports for all API definitions in your API center:
67+
To view an analysis summary in your API center:
8668

8769
1. In the portal, navigate to your API center.
8870
1. In the left-hand menu, under **Governance**, select **API Analysis**. The summary appears.
8971

9072
:::image type="content" source="media/enable-api-analysis-linting/api-analysis-summary.png" alt-text="Screenshot of the API analysis summary in the portal." lightbox="media/enable-api-analysis-linting/api-analysis-summary.png":::
9173

92-
Optionally select the API Analysis Report icon to view the detailed analysis report for an API definition.
74+
1. Optionally select the API Analysis Report icon for an API definition. The definition's API analysis report appears, as shown in the following screenshot.
75+
76+
:::image type="content" source="media/enable-api-analysis-linting/api-analysis-report.png" alt-text="Screenshot of an API analysis report in the portal." lightbox="media/enable-api-analysis-linting/api-analysis-report.png":::
77+
78+
> [!TIP]
79+
> You can also view the API analysis report by selecting **Analysis** from the API definition's menu bar.
9380
9481
## Customize ruleset
9582

@@ -112,7 +99,7 @@ Before deploying the custom ruleset to your API center, validate it locally. The
11299

113100
This step makes the custom ruleset the active API style guide for linting.
114101

115-
Now, when you an OpenAPI-based API definition file, a local linting operation is automatically triggered in Visual Studio Code. Results are displayed inline in the editor and in the **Problems** window (**View > Problems** or **Ctrl+Shift+M**).
102+
Now, when you open an OpenAPI-based API definition file, a local linting operation is automatically triggered in Visual Studio Code. Results are displayed inline in the editor and in the **Problems** window (**View > Problems** or **Ctrl+Shift+M**).
116103

117104
:::image type="content" source="media/enable-managed-api-analysis-linting/validate-local-linting.png" alt-text="Screenshot of linting an API definition in Visual Studio Code." lightbox="media/enable-managed-api-analysis-linting/validate-local-linting.png":::
118105

@@ -128,7 +115,7 @@ To deploy the custom ruleset to your API center:
128115

129116
A message notifies you after the rules are successfully deployed to your API center. The linting engine uses the updated ruleset to analyze API definitions.
130117

131-
View the API analysis reports in the portal to see the results of linting with the updated ruleset.
118+
To see the results of linting with the updated ruleset, view the API analysis reports in the portal.
132119

133120
## Related content
134121

348 Bytes
Loading

0 commit comments

Comments
 (0)