Skip to content

Preparing a new tag without the conflicting operation "Operations_List" #17315

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

Merged
merged 4 commits into from
Jan 21, 2022
Merged

Preparing a new tag without the conflicting operation "Operations_List" #17315

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
5e83735
Preparing a new tag without the conflicting operation "Operations_List"
tokaplan Jan 12, 2022
3873481
Correcting components_API.json version for the tag
tokaplan Jan 12, 2022
00c2798
Updating the latest tag, adding reference materials to readme.md
tokaplan Jan 12, 2022
17abfcd
Avocado error fix
tokaplan Jan 13, 2022
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
23 changes: 0 additions & 23 deletions ...ights/resource-manager/Microsoft.Insights/stable/2021-10-14/examples/Operations_List.json
View file
Open in desktop

This file was deleted.

38 changes: 0 additions & 38 deletions ...licationinsights/resource-manager/Microsoft.Insights/stable/2021-10-14/livetoken_API.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,44 +36,6 @@
}
},
"paths": {
"/providers/Microsoft.Insights/operations": {
"get": {
"tags": [
"Operations"
],
"summary": "List available operations.",
"description": "List the available operations supported by the resource provider.",
"operationId": "Operations_List",
"consumes": [],
"produces": [
"application/json"
],
"parameters": [
{
"$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"$ref": "#/definitions/OperationsListResult"
}
},
"default": {
"description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error."
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"x-ms-examples": {
"Operations_List": {
"$ref": "./examples/Operations_List.json"
}
}
}
},
"/{resourceUri}/providers/Microsoft.Insights/generatelivetoken": {
"post": {
"tags": [
Expand Down
37 changes: 36 additions & 1 deletion specification/applicationinsights/resource-manager/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,16 @@ To see additional help and options, run:

---

### Before adding a new tag

Please familiarize yourself with the following before adding a new tag:

- Discussion on negative impact of multiple _api-version_'s within a tag: [Azure/azure-sdk-for-rust#563](https://github.com/Azure/azure-sdk-for-rust/issues/563)
- [API Spec & SDK Package Versioning Considerations](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/481/API-Spec-SDK-Package-Versioning-Considerations)
- [Manual Process: Adding new API version](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version)

---

## Configuration

### Basic Information
Expand All @@ -28,7 +38,7 @@ These are the global settings for the ApplicationInsights API.
title: ApplicationInsightsManagementClient
description: Composite Swagger for Application Insights Management Client
openapi-type: arm
tag: package-2021-11-01
tag: package-2022-01-11
```

### Suppression
Expand Down Expand Up @@ -222,6 +232,31 @@ directive:

```

### Tag: package-2022-01-11
Copy link
Contributor

@vutran01 vutran01 Jan 12, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

package-2022-01-11

we call every Tag "package-" but maybe we should have special tag if we plan to publish the sdk for it? either that or have appropriate comments so the next person doesn't overwrite or regress the versions. maybe all add links to "best practices" and other sdk architecture

• Azure/azure-sdk-for-rust#563
• Azure/azure-sdk-for-rust#567
Please also read these docs:
• https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/481/API-Spec-SDK-Package-Versioning-Considerations
• https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/83/Manual-Process-Adding-new-API-version
#Closed

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@vutran01 , is there another reason to declare a tag? I thought they were only for generating SDKs... I'll add the links, that's a good idea I think.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yes, for building the sdk but not every tag is used to publish the sdk

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added the links. Feel free to propose a convention, I don't think I have enough understanding of the overall process to have an opinion here. I don't even know why we would want to build an SDK and then not publish it.


These settings apply only when `--tag=package-2022-01-11` is specified on the command line.

``` yaml $(tag) == 'package-2022-01-11'
input-file:
- Microsoft.Insights/stable/2015-05-01/aiOperations_API.json
- Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json
- Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json
- Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json
- Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json
- Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json
- Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json
- Microsoft.Insights/stable/2015-05-01/favorites_API.json
- Microsoft.Insights/stable/2015-05-01/webTestLocations_API.json
- Microsoft.Insights/stable/2015-05-01/webTests_API.json
- Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json
- Microsoft.Insights/stable/2020-11-20/workbookTemplates_API.json
- Microsoft.Insights/stable/2021-03-08/myworkbooks_API.json
- Microsoft.Insights/stable/2021-08-01/workbooks_API.json
- Microsoft.Insights/stable/2020-02-02/components_API.json
- Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json
- Microsoft.Insights/stable/2021-10-14/livetoken_API.json
```

### Tag: package-2021-11-01

These settings apply only when `--tag=package-2021-11-01` is specified on the command line.
Expand Down