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.

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

2021-01-01 minor updates #14656

Merged
merged 3 commits into from
Jun 10, 2021

Conversation

renuka-raju
Copy link
Contributor

@renuka-raju renuka-raju commented Jun 3, 2021

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. - Upcoming Release
  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
    • Ensure to copy the existing version into new directory structure for first commit (including refactoring) and then push new changes including version updates in separate commits. This is required to review the changes efficiently.
    • 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, @renuka-raju 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 3, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 10 items are listed, please refer to log for more details.

    Rule Message
    R3021 - PathResourceTypeNameCamelCase Resource type naming must follow camel case. Path: '/subscriptions/{subscriptionId}/providers/Microsoft.Peering/CheckServiceProviderAvailability'
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L65
    R4009 - RequiredReadOnlySystemData The response of operation:'PeerAsns_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L216
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredAsns_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L464
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredPrefixes_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L699
    R4009 - RequiredReadOnlySystemData The response of operation:'Peerings_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L934
    R4009 - RequiredReadOnlySystemData The response of operation:'Prefixes_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L1416
    R4009 - RequiredReadOnlySystemData The response of operation:'PeeringServices_Get' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L1704
    R4009 - RequiredReadOnlySystemData The response of operation:'PeerAsns_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L257
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredAsns_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L519
    R4009 - RequiredReadOnlySystemData The response of operation:'RegisteredPrefixes_CreateOrUpdate' is defined without 'systemData'. Consider adding the systemData to the response.
    Location: Microsoft.Peering/stable/2021-01-01/peering.json#L754
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
    There are no breaking changes.
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"peering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"peering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"peering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] Lint(RPaaS) succeeded [Detail] [Expand]
    Validation passes for Lint(RPaaS).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 3, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️[Staging] SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-peering - 1.0.0
    ️✔️azure-sdk-for-go - peering/mgmt/2021-01-01/peering - v55.1.0
    ️✔️azure-sdk-for-go - peering/mgmt/2020-10-01/peering - v55.1.0
    ️✔️azure-sdk-for-go - peering/mgmt/2020-04-01/peering - v55.1.0
    ️✔️azure-sdk-for-go - preview/peering/mgmt/2020-01-01-preview/peering - v55.1.0
    ️✔️azure-sdk-for-go - preview/peering/mgmt/2019-09-01-preview/peering - v55.1.0
    ️✔️azure-sdk-for-go - preview/peering/mgmt/2019-08-01-preview/peering - v55.1.0
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 645c778. 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] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      cmderr	[automation_init.sh] ERROR: pip's dependency resolver does not currently take into account all the packages that are installed. This behaviour is the source of the following dependency conflicts.
      cmderr	[automation_init.sh] azure-mgmt-core 1.2.2 requires azure-core<2.0.0,>=1.9.0, but you have azure-core 1.6.0 which is incompatible.
      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
    • ️✔️azure-mgmt-peering [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model PeeringServiceProvider has a new parameter peering_locations
      info	[Changelog]   - Model PeeringService has a new parameter provider_backup_peering_location
      info	[Changelog]   - Model PeeringService has a new parameter provider_primary_peering_location
      info	[Changelog]   - Model DirectConnection has a new parameter microsoft_tracking_id
      info	[Changelog]   - Added operation group ReceivedRoutesOperations
      info	[Changelog]   - Added operation group CdnPeeringPrefixesOperations
      info	[Changelog]
      info	[Changelog] **Breaking changes**
      info	[Changelog]
      info	[Changelog]   - Model ErrorResponse has a new signature
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 645c778. 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-06-10 00:52:22 INFO [VERSION][Found] current version "com.azure.resourcemanager:azure-resourcemanager-peering;1.0.0-beta.1;1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-10 00:52:22 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.2"
      cmderr	[generate.py] 2021-06-10 00:52:22 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.29 --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/peering/azure-resourcemanager-peering --java.namespace=com.azure.resourcemanager.peering   --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/peering/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [CI][Skip] ci.yml already has module azure-resourcemanager-peering
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Skip] pom already has module azure-resourcemanager-peering
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Skip] pom already has module sdk/peering
      cmderr	[generate.py] 2021-06-10 00:52:58 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-peering [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG Got artifact_id: azure-resourcemanager-peering
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG Got artifact: azure-resourcemanager-peering-1.0.0-beta.2-javadoc.jar
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG Got artifact: azure-resourcemanager-peering-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG Match jar package: azure-resourcemanager-peering-1.0.0-beta.2.jar
      cmderr	[Inst] 2021-06-10 00:56:22 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14656/azure-sdk-for-java/azure-resourcemanager-peering/azure-resourcemanager-peering-1.0.0-beta.2.jar\" -o azure-resourcemanager-peering-1.0.0-beta.2.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-peering -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-peering-1.0.0-beta.2.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 645c778. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️peering/mgmt/2021-01-01/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️peering/mgmt/2020-10-01/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️peering/mgmt/2020-04-01/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/peering/mgmt/2020-01-01-preview/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/peering/mgmt/2019-09-01-preview/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    • ️✔️preview/peering/mgmt/2019-08-01-preview/peering [View full logs]  [Release SDK Changes]
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 645c778. 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 --use=@microsoft.azure/autorest.csharp@2.3.82 --csharp-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-net/sdk ../azure-rest-api-specs/specification/peering/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.Management.Peering [View full logs]  [Release SDK Changes]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 645c778. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION --use=@microsoft.azure/autorest.typescript@4.6.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/peering/resource-manager/readme.md
    • ️✔️@azure/arm-peering [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/peeringManagementClient.js → ./dist/arm-peering.js...
      cmderr	[npmPack] created ./dist/arm-peering.js in 472ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 645c778. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      cmderr	[generateScript.sh] (node:2973) UnhandledPromiseRejectionWarning: Error: ENOENT: no such file or directory, unlink '/home/vsts/work/1/s/azure-resource-manager-schemas/schemas/2019-09-01-preview/Microsoft.Peering.json'
      cmderr	[generateScript.sh] (Use `node --trace-warnings ...` to show where the warning was created)
      cmderr	[generateScript.sh] (node:2973) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch block, or by rejecting a promise which was not handled with .catch(). To terminate the node process on unhandled promise rejection, use the CLI flag `--unhandled-rejections=strict` (see https://nodejs.org/api/cli.html#cli_unhandled_rejections_mode). (rejection id: 1)
      cmderr	[generateScript.sh] (node:2973) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the Node.js process with a non-zero exit code.
    • ️✔️peering [View full logs]  [Release Schema Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @renuka-raju, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @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.

    @renuka-raju
    Copy link
    Contributor Author

    Reverted swagger correctness changes for s360. Will be adding them as a part of 2021-06-01 peering api for upcoming features.

    @renuka-raju renuka-raju changed the title 2021-01-01 minor updates and swagger correctness 2021-01-01 minor updates Jun 7, 2021
    @ArcturusZhang
    Copy link
    Member

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    Copy link
    Member

    @ArcturusZhang ArcturusZhang left a comment

    Choose a reason for hiding this comment

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

    Hi @renuka-raju could we also change the readme.go.md file to combine all the multiapi section into one? This is causing go generation pipeline failures

    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    * 2021-01-01 minor updates and swagger correctness
    
    * Reverting swagger correctness changes
    
    * combining multiapi section in readmego
    
    Co-authored-by: Renuka Raju <rraju@microsoft.com>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * 2021-01-01 minor updates and swagger correctness
    
    * Reverting swagger correctness changes
    
    * combining multiapi section in readmego
    
    Co-authored-by: Renuka Raju <rraju@microsoft.com>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants