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

Move swagger from private repo to public repo #14648

Merged
merged 8 commits into from
Jun 9, 2021
Merged

Move swagger from private repo to public repo #14648

merged 8 commits into from
Jun 9, 2021

Conversation

sureleo
Copy link
Contributor

@sureleo sureleo commented Jun 2, 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. The swagger is already checked in in RPSaaSMaster branch in private repo. This is just the effort to copy the latest version to public repo.
    • 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
    • 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, @sureleo 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-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 2, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 40 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:

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

    Rule Message
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1017
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1080
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1124
    ⚠️ R1001 - OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1168
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'DataControllers_PutDataController' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1017
    ⚠️ R1007 - PatchInOperationName 'PATCH' operation 'DataControllers_PatchDataController' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1168
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1783
    ⚠️ R3017 - GuidUsage Guid used in model definition 'OnPremiseProperty' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L1694
    ⚠️ R3017 - GuidUsage Guid used in model definition 'LogAnalyticsWorkspaceConfig' for property 'workspaceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L2132
    ⚠️ R3017 - GuidUsage Guid used in model definition 'UploadServicePrincipal' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board.
    Location: Microsoft.AzureArcData/preview/2021-06-01-preview/azurearcdata.json#L2152
    ️️✔️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":"azurearcdata/resource-manager/readme.md",
    "tag":"package-preview-2021-06-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
    "tag":"package-preview-2021-06-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
    "tag":"package-preview-2021-06-01",
    "details":"> Installing AutoRest extension '@autorest/modelerfour' (4.15.456)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"azurearcdata/resource-manager/readme.md",
    "tag":"package-preview-2021-06-01",
    "details":"> Installed 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 2, 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-azurearcdata - first release
    ️✔️azure-sdk-for-go - preview/azurearcdata/mgmt/2021-06-01-preview/azurearcdata - v55.1.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️❌ azure-sdk-for-java failed [Detail]
    • Failed [Logs]Release - Generate from 50eae85. 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-09 05:33:39 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-azurearcdata"
      cmderr	[generate.py] 2021-06-09 05:33:39 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-06-09 05:33:39 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/azurearcdata/azure-resourcemanager-azurearcdata --java.namespace=com.azure.resourcemanager.azurearcdata   --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/azurearcdata/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [POM][Skip] pom already has module azure-resourcemanager-azurearcdata
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-09 05:34:07 INFO [POM][Success] Write to root pom
      failed to connect to github.com: Connection timed out
      Error: failed to connect to github.com: Connection timed out
    • ️✔️azure-resourcemanager-azurearcdata [View full logs
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG Got artifact_id: azure-resourcemanager-azurearcdata
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG Got artifact: azure-resourcemanager-azurearcdata-1.0.0-beta.1-javadoc.jar
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG Got artifact: azure-resourcemanager-azurearcdata-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG Match jar package: azure-resourcemanager-azurearcdata-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-09 05:36:57 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14648/azure-sdk-for-java/azure-resourcemanager-azurearcdata/azure-resourcemanager-azurearcdata-1.0.0-beta.1.jar\" -o azure-resourcemanager-azurearcdata-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-azurearcdata -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-azurearcdata-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
      error	Fatal error: failed to connect to github.com: Connection timed out
      error	The following packages are still pending:
      error		azure-resourcemanager-azurearcdata
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 50eae85. 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
    • ️✔️preview/azurearcdata/mgmt/2021-06-01-preview/azurearcdata [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 50eae85. 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/azurearcdata/resource-manager/readme.md
    • ️✔️@azure/arm-azurearcdata [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/azureArcDataManagementClient.js → ./dist/arm-azurearcdata.js...
      cmderr	[npmPack] created ./dist/arm-azurearcdata.js in 331ms
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 50eae85. 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/azurearcdata/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.AzureArcData [View full logs]  [Release SDK Changes]
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 50eae85. 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
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    Posted by Swagger Pipeline | How to fix these errors?

    @zhenglaizhang
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @sureleo sureleo changed the title Dev/shul/move 2021 06 01 to public Move swagger from private repo to public repo Jun 3, 2021
    @sureleo sureleo marked this pull request as ready for review June 3, 2021 22:06
    @raych1
    Copy link
    Member

    raych1 commented Jun 7, 2021

    @sureleo , can you paste the link of original PR in private spec repository? You should use the link there to publish that PR to public repo.

    @sureleo
    Copy link
    Contributor Author

    sureleo commented Jun 7, 2021

    @raych1 Sorry I am not aware. Here is the link of swagger in private repo.

    I couldn't find the link you mentioned... is it because I am on RPSaaSMaster rather than master branch?

    @sureleo
    Copy link
    Contributor Author

    sureleo commented Jun 8, 2021

    /azp run

    @azure-pipelines
    Copy link

    Commenter does not have sufficient privileges for PR 14648 in repo Azure/azure-rest-api-specs

    @raych1
    Copy link
    Member

    raych1 commented Jun 8, 2021

    @raych1 Sorry I am not aware. Here is the link of swagger in private repo.

    I couldn't find the link you mentioned... is it because I am on RPSaaSMaster rather than master branch?

    Right, rpsaasmaster branch PR doesn't have the link for publish. Above PR only has the change on the readme files. Can you paste related PRs in private repo?

    @sureleo
    Copy link
    Contributor Author

    sureleo commented Jun 8, 2021

    @raych1 Sorry I am not aware. Here is the link of swagger in private repo.
    I couldn't find the link you mentioned... is it because I am on RPSaaSMaster rather than master branch?

    Right, rpsaasmaster branch PR doesn't have the link for publish. Above PR only has the change on the readme files. Can you paste related PRs in private repo?

    Here is the PR to master branch in Private repo. This is reflecting all the changes on RPSaaSMaster branch for the latest version (2021-06-01-preview). This PR and private repo PR are just copying whatever on RPSaaSMaster branch with 2020-12-08-preview and 2021-03-02-preview removed (We are planning to deprecate these api versions).

    I still cannot find the publish it to public repo though... Am I missing anything?

    @raych1
    Copy link
    Member

    raych1 commented Jun 9, 2021

    @raych1 Sorry I am not aware. Here is the link of swagger in private repo.
    I couldn't find the link you mentioned... is it because I am on RPSaaSMaster rather than master branch?

    Right, rpsaasmaster branch PR doesn't have the link for publish. Above PR only has the change on the readme files. Can you paste related PRs in private repo?

    Here is the PR to master branch in Private repo. This is reflecting all the changes on RPSaaSMaster branch for the latest version (2021-06-01-preview). This PR and private repo PR are just copying whatever on RPSaaSMaster branch with 2020-12-08-preview and 2021-03-02-preview removed (We are planning to deprecate these api versions).

    I still cannot find the publish it to public repo though... Am I missing anything?

    Ok, this PR doesn't need ARM review as it just copies all the existed api version from rpsaasmaster branch to public master.

    @raych1 raych1 merged commit 50eae85 into Azure:master Jun 9, 2021
    asager pushed a commit to asager/azure-rest-api-specs that referenced this pull request Jun 24, 2021
    * Adding Swagger for AzureData on AzureArc
    
    * rename folder to AzureArcData
    
    * Adding Operations
    
    * Revert "Adding Operations". Keeping it the same with old approved
    swagger
    
    This reverts commit 83ff554.
    
    * Bump version to 2020-12-08
    
    * Move 2021-06-01-preview to public repo
    
    * Fixing SDK generation
    
    Co-authored-by: Shuo Li <[email protected]>
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Adding Swagger for AzureData on AzureArc
    
    * rename folder to AzureArcData
    
    * Adding Operations
    
    * Revert "Adding Operations". Keeping it the same with old approved
    swagger
    
    This reverts commit 83ff554.
    
    * Bump version to 2020-12-08
    
    * Move 2021-06-01-preview to public repo
    
    * Fixing SDK generation
    
    Co-authored-by: Shuo Li <[email protected]>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants