Skip to content

build: apic-extension v1.2.0b3 release - analysis follow up #826

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
frankqianms wants to merge 10 commits into
base: main
Choose a base branch
from
Open

build: apic-extension v1.2.0b3 release - analysis follow up #826

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
635db87
fix: fix bad example in apic create (#15)
frankqianms Jan 13, 2025
7c3c304
feat: add analysis rules (#14)
frankqianms Jan 13, 2025
8d2d15a
Merge branch 'dev' of https://github.com/blackchoey/aaz into dev
frankqianms Jan 21, 2025
5546420
Merge branch 'main' into dev
frankqianms Jan 21, 2025
808561b
feat: add filter property in api-analysis create
frankqianms Jan 22, 2025
884be03
refactor: set default analyzer-type in aaz
frankqianms Feb 24, 2025
aec1062
refactor: remove preview tag for some integration commands
frankqianms Feb 25, 2025
8dd5975
chore: update spec for filter param
frankqianms Mar 7, 2025
c1ba4a0
fix: regenerate according to new spec
frankqianms Mar 12, 2025
ac6dc19
fix: remove preview tag of integrate cmds
frankqianms Aug 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis create_

Create new or updates existing API analyzer configuration.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30=/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{} 2024-12-15-preview -->

#### examples

- Create an API Analysis rule config
```bash
apic api-analysis create -g contoso-resources -n contoso -c spectral-openapi
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis delete_

Delete deletes API analyzer configuration.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30=/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{} 2024-12-15-preview -->

#### examples

- Delete an API Analysis rule config
```bash
apic api-analysis delete -g contoso-resources -n contoso -c spectral-openapi
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_export-ruleset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis export-ruleset_

Exports the API analyzer ruleset.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30vZXhwb3J0cnVsZXNldA==/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{}/exportruleset 2024-12-15-preview -->

#### examples

- Export an API Analysis ruleset
```bash
apic api-analysis export-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\\path\\for\\output\\files'
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_import-ruleset.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis import-ruleset_

Imports the API analyzer ruleset.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30vaW1wb3J0cnVsZXNldA==/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{}/importruleset 2024-12-15-preview -->

#### examples

- Import an API Analysis ruleset
```bash
apic api-analysis import-ruleset -g contoso-resources -n contoso -c spectral-openapi --path '\\path\\to\\ruleset\\folder'
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis list_

List API analyzer configurations.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3M=/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs 2024-12-15-preview -->

#### examples

- List all API Analysis rule configs for the service
```bash
apic api-analysis list -g contoso-resources -n contoso
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis show_

Get details of the API analyzer configuration.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30=/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{} 2024-12-15-preview -->

#### examples

- Show details of an API Analysis rule config
```bash
apic api-analysis show -g contoso-resources -n contoso -c spectral-openapi
```
16 changes: 16 additions & 0 deletions Commands/apic/api-analysis/_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
# [Command] _apic api-analysis update_

Update new or updates existing API analyzer configuration.

## Versions

### [2024-12-15-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hbmFseXplcmNvbmZpZ3Mve30=/2024-12-15-preview.xml) **Preview**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/analyzerconfigs/{} 2024-12-15-preview -->

#### examples

- Update an API Analysis rule config
```bash
apic api-analysis update -g contoso-resources -n contoso -c spectral-openapi
```
26 changes: 26 additions & 0 deletions Commands/apic/api-analysis/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# [Group] _apic api-analysis_

Manage Azure API Center service api analysis features

## Commands

- [create](/Commands/apic/api-analysis/_create.md)
: Create new or updates existing API analyzer configuration.

- [delete](/Commands/apic/api-analysis/_delete.md)
: Delete deletes API analyzer configuration.

- [export-ruleset](/Commands/apic/api-analysis/_export-ruleset.md)
: Exports the API analyzer ruleset.

- [import-ruleset](/Commands/apic/api-analysis/_import-ruleset.md)
: Imports the API analyzer ruleset.

- [list](/Commands/apic/api-analysis/_list.md)
: List API analyzer configurations.

- [show](/Commands/apic/api-analysis/_show.md)
: Get details of the API analyzer configuration.

- [update](/Commands/apic/api-analysis/_update.md)
: Update new or updates existing API analyzer configuration.
2 changes: 1 addition & 1 deletion Commands/apic/integration/_create.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Create new or updates existing API source.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-12-01-preview -->
2 changes: 1 addition & 1 deletion Commands/apic/integration/_delete.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Delete specified API source.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-12-01-preview -->
2 changes: 1 addition & 1 deletion Commands/apic/integration/_head.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Checks if specified API source exists.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-12-01-preview -->
2 changes: 1 addition & 1 deletion Commands/apic/integration/_list.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ List a collection of API sources.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2Vz/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2Vz/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources 2024-12-01-preview -->
2 changes: 1 addition & 1 deletion Commands/apic/integration/_show.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Get details of the API source.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-12-01-preview -->
2 changes: 1 addition & 1 deletion Commands/apic/integration/_update.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,6 @@ Update new or updates existing API source.

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-06-01-preview -->

### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Preview**
### [2024-12-01-preview](/Resources/mgmt-plane/L3N1YnNjcmlwdGlvbnMve30vcmVzb3VyY2Vncm91cHMve30vcHJvdmlkZXJzL21pY3Jvc29mdC5hcGljZW50ZXIvc2VydmljZXMve30vd29ya3NwYWNlcy97fS9hcGlzb3VyY2VzL3t9/2024-12-01-preview.xml) **Stable**

<!-- mgmt-plane /subscriptions/{}/resourcegroups/{}/providers/microsoft.apicenter/services/{}/workspaces/{}/apisources/{} 2024-12-01-preview -->
3 changes: 3 additions & 0 deletions Commands/apic/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,9 @@ Manage Azure API Center services
- [api](/Commands/apic/api/readme.md)
: Commands to manage APIs in API Center

- [api-analysis](/Commands/apic/api-analysis/readme.md)
: Manage Azure API Center service api analysis features

- [environment](/Commands/apic/environment/readme.md)
: Commands to manage environments in API Center

Expand Down
Loading
Loading