Skip to content
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

Jump to bottom

Add Workbooks_ListBySubscription Definition #13319

Merged
merged 2 commits into from
Mar 17, 2021
Merged

Add Workbooks_ListBySubscription Definition #13319

merged 2 commits into from
Mar 17, 2021

Conversation

tonykslee
Copy link
Contributor

@tonykslee tonykslee commented Mar 8, 2021 •
edited
Loading

Adding the missing api definition for GET Workbooks_ListBySubscription along with corresponding example file.

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with this PR by answering the following questions.

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No, no need to refresh for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service

  • Please ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.

  • If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.

Breaking Change Review Checklist

If there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.

Please follow the link to find more details on PR review process.

@openapi-workflow-bot
Copy link

Hi, @tonykslee Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

    • Any feedback about review process or workflow bot, pls contact swagger and tools team. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]

    Rule Message
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Insights/stable/2020-10-20/workbooks_API.json#L37:5
    ️⚠️LintDiff: 3 Warnings warning [Detail]

    Rule Message
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList
    Location: Microsoft.Insights/stable/2020-10-20/workbooks_API.json#L75
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksList2
    Location: Microsoft.Insights/stable/2020-10-20/workbooks_API.json#L75
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: WorkbooksManagedList
    Location: Microsoft.Insights/stable/2020-10-20/workbooks_API.json#L132
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️[Staging] Cross Version BreakingChange (Base on stable version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️❌[Staging] SDK Track2 Validation: 6 Errors, 92 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ❌ PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined => "#/components/schemas/schemas:346" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    ❌ PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined => "description":"The client ID of resource.",
    "readOnly":true,
    "$ref":"#/components/schemas/schemas:349" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    ❌ AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"Error: Plugin prechecker reported failure."
    ❌ PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Duplicate Schema named ManagedIdentity -- properties.userAssignedIdentities.$ref: undefined => "#/components/schemas/schemas:346" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    ❌ PreCheck/DuplicateSchema "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Duplicate Schema named UserAssignedIdentities -- properties.clientId: undefined => "description":"The client ID of resource.",
    "readOnly":true,
    "$ref":"#/components/schemas/schemas:349" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    ❌ AutorestCore/Exception "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-10-20",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'AnnotationsListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ApplicationInsightsComponentAPIKeyListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ComponentsResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"applicationinsights/resource-manager/readme.md",
    "tag":"package-2020-02-12",
    "details":"The schema 'ComponentsResource-tags' with an undefined type and additionalProperties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Mar 8, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️❌ azure-sdk-for-python failed [Detail]
    • ❌Failed [Logs]Release - Generate from dc8093d. SDK Automation 14.0.0 
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
cmdout	[automation_generate.sh] [Autorest]../azure-sdk-for-python_tmp/generateOutput.json does not exist!!!Error happened during package
error	Script return with result [failed] code [1] signal [null] cwd [azure-sdk-for-python]: sh scripts/automation_generate.sh
warn	Skip package processing as generation is failed
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from dc8093d. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
cmderr	[generate.py] 2021-03-17 02:17:03 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-applicationinsights"
cmderr	[generate.py] 2021-03-17 02:17:03 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-03-17 02:17:03 INFO autorest --version=3.1.3 --use=@autorest/[email protected] --java.azure-libraries-for-java-folder=/home/vsts/work/1/s/azure-sdk-for-java --java.output-folder=/home/vsts/work/1/s/azure-sdk-for-java/sdk/applicationinsights/azure-resourcemanager-applicationinsights --java.namespace=com.azure.resourcemanager.applicationinsights   --java --pipeline.modelerfour.additional-checks=false --pipeline.modelerfour.lenient-model-deduplication=true --azure-arm --verbose --sdk-integration --fluent=lite --java.fluent=lite --java.license-header=MICROSOFT_MIT_SMALL ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [POM][Skip] pom already has module azure-resourcemanager-applicationinsights
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-03-17 02:17:33 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-applicationinsights [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Got artifact_id: azure-resourcemanager-applicationinsights
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.1-sources.jar
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.1-javadoc.jar
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Got artifact: azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG Match jar package: azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar
cmderr	[Inst] 2021-03-17 02:20:02 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/13319/azure-sdk-for-java/azure-resourcemanager-applicationinsights/azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar\" -o azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-applicationinsights -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-applicationinsights-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc8093d. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
    • ️✔️@azure/arm-appinsights [View full logs]  [Release SDK Changes] 
      cmderr	[npmPack] loaded rollup.config.js with warnings
cmderr	[npmPack] (!) Unused external imports
cmderr	[npmPack] default imported from external module 'rollup' but never used
cmderr	[npmPack] ./esm/applicationInsightsManagementClient.js → ./dist/arm-appinsights.js...
cmderr	[npmPack] created ./dist/arm-appinsights.js in 222ms
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc8093d. SDK Automation 14.0.0 
      warn	Skip initScript due to not configured
command	sudo apt-get install -y dotnet-sdk-5.0
command	autorest --version=V2 --csharp --reflect-api-versions --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
cmderr	[Autorest] realpath(): Permission denied
    • ️✔️Microsoft.Azure.ApplicationInsights [View full logs]  [Release SDK Changes]
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc8093d. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/[email protected] --version=3.0.6374 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/applicationinsights/resource-manager/readme.md
    • ️✔️applicationinsights [View full logs]  [Release Schema Changes] 
      cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN
cmderr	[resource-manager] Using request for node-pre-gyp https download
cmderr	[resource-manager]  [email protected] No repository field.
cmderr	[resource-manager] npm WARN optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from dc8093d. SDK Automation 14.0.0 
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	go run ./tools/generator/main.go ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️appinsights/mgmt/2015-05-01/insights [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    This was referenced Mar 8, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    @tonykslee
    Copy link
    Contributor Author

    If I make a new api-version (due to breaking change) will it resolve the S360 item even though this 2020-10-20 api-version is still missing the operation definition?

    @tonykslee tonykslee assigned tonykslee and unassigned tonykslee Mar 8, 2021
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Mar 15, 2021
    @akning-ms
    Copy link
    Contributor

    If I make a new api-version (due to breaking change) will it resolve the S360 item even though this 2020-10-20 api-version is still missing the operation definition?

    Yes. if there is still a call for operation in 2020-10-20, but we just track last 2 API version

    @akning-ms akning-ms merged commit dc8093d into Azure:master Mar 17, 2021
    This was referenced Mar 17, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Mar 17, 2021
    Closed
    MirzaSikander pushed a commit to MirzaSikander/azure-rest-api-specs that referenced this pull request Mar 22, 2021
    @tonykslee @MirzaSikander
    Add Workbooks_ListBySubscription Definition (Azure#13319)
    4067533 
    * added listBySubscription operation to workbooks_API along with the corresponding example json

* fixed operationId
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @tonykslee @mkarmark
    Add Workbooks_ListBySubscription Definition (Azure#13319)
    d0d6812 
    * added listBySubscription operation to workbooks_API along with the corresponding example json

* fixed operationId
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @JeffreyRichter JeffreyRichter JeffreyRichter approved these changes

    @hectorhdzg hectorhdzg Awaiting requested review from hectorhdzg

    @lzchen lzchen Awaiting requested review from lzchen

    @ramthi ramthi Awaiting requested review from ramthi

    @trask trask Awaiting requested review from trask

    Assignees

    @akning-ms akning-ms

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 FixS360
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    3 participants
    @tonykslee @akning-ms @JeffreyRichter