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

moving swagger to stable #14992

Merged
merged 5 commits into from
Jun 30, 2021
Merged

Conversation

vakuncha
Copy link
Contributor

@vakuncha vakuncha commented Jun 25, 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.
  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, @vakuncha 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-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jun 25, 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
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listmonitoredresources' in:'MonitoredResources_List'. Consider updating the operationId
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L371
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listdeploymentinfo' in:'DeploymentInfo_List'. Consider updating the operationId
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L419
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'listvmhost' in:'VMHost_List'. Consider updating the operationId
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L667
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'vmingestiondetails' in:'VMIngestion_Details'. Consider updating the operationId
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L715
    ⚠️ R2066 - PostOperationIdContainsUrlVerb OperationId should contain the verb: 'vmcollectionupdate' in:'VMCollection_Update'. Consider updating the operationId
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L760
    ⚠️ R3010 - TrackedResourceListByImmediateParent The child tracked resource, 'tagRules' with immediate parent 'ElasticMonitorResource', must have a list by immediate parent operation.
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L1368
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L873
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendAadLogs
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L1333
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendSubscriptionLogs
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L1337
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: sendActivityLogs
    Location: Microsoft.Elastic/stable/2020-07-01/elastic.json#L1341
    ️️✔️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: 17 Errors, 0 Warnings failed [Detail]
    The following breaking changes are detected by comparison with latest preview version:

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

    Rule Message
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L39:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L78:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L120:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L165:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L211:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L275:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L326:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L375:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L423:9
    1019 - RemovedEnumValue The new version is removing enum value(s) '2020-07-01-preview' from the old version.
    Old: Microsoft.Elastic/preview/2020-07-01-preview/elastic.json#L468:9
    ️️✔️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":"elastic/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"elastic/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"elastic/resource-manager/readme.md",
    "tag":"package-2020-07-01",
    "details":"> Loading AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"elastic/resource-manager/readme.md",
    "tag":"package-2020-07-01",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"elastic/resource-manager/readme.md",
    "tag":"package-2020-07-01-preview",
    "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-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 25, 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-elastic - 1.0.0b1
    ️✔️azure-sdk-for-go - preview/elastic/mgmt/2020-07-01-preview/elastic - v55.4.0
    ️✔️azure-sdk-for-go - elastic/mgmt/2020-07-01/elastic - v55.4.0
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from eee9cbb. 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-30 01:22:28 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-elastic"
      cmderr	[generate.py] 2021-06-30 01:22:28 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
      cmderr	[generate.py] 2021-06-30 01:22:28 INFO autorest --version=3.1.3 --use=@autorest/java@4.0.30 --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/elastic/azure-resourcemanager-elastic --java.namespace=com.azure.resourcemanager.elastic   --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/elastic/resource-manager/readme.md
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [CI][Success] Write to ci.yml
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [POM][Process] dealing with pom.xml
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [POM][Skip] pom already has module azure-resourcemanager-elastic
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [POM][Success] Write to pom.xml
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [POM][Process] dealing with root pom
      cmderr	[generate.py] 2021-06-30 01:23:00 INFO [POM][Success] Write to root pom
    • ️✔️azure-resourcemanager-elastic [View full logs]  [Release SDK Changes]
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG Got artifact_id: azure-resourcemanager-elastic
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG Got artifact: pom.xml
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG Got artifact: azure-resourcemanager-elastic-1.0.0-beta.1-sources.jar
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG Got artifact: azure-resourcemanager-elastic-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG Match jar package: azure-resourcemanager-elastic-1.0.0-beta.1.jar
      cmderr	[Inst] 2021-06-30 01:24:43 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/14992/azure-sdk-for-java/azure-resourcemanager-elastic/azure-resourcemanager-elastic-1.0.0-beta.1.jar\" -o azure-resourcemanager-elastic-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-elastic -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-elastic-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
      ```"}
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from eee9cbb. 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
    • ️✔️elastic/mgmt/2020-07-01/elastic [View full logs]  [Release SDK Changes]
      info	[Changelog] This is a new package
    • ️✔️preview/elastic/mgmt/2020-07-01-preview/elastic [View full logs
      info	[Changelog] No exported changes
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from eee9cbb. 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.7.0 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/elastic/resource-manager/readme.md
    • ️✔️@azure/arm-elastic [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/microsoftElastic.js → ./dist/arm-elastic.js...
      cmderr	[npmPack] created ./dist/arm-elastic.js in 332ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from eee9cbb. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      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
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from eee9cbb. Azure CLI Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	python3 -m venv venv
      command	pip install --upgrade setuptools wheel pip
      command	pip install pathlib jinja2 msrestazure
      command	autorest --az --use=@autorest/az@latest --version=3.0.6271 --clear-output-folder=true --azure-cli-extension-folder=/home/vsts/work/1/s/azure-cli-extensions ../azure-rest-api-specs/specification/elastic/resource-manager/readme.md
      cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
      cmdout	[Autorest] WARNING (): cli.auto-parameter-hidden is not true, skip visibility cleaner
      cmderr	[Autorest] BELOW TEST SCENARIO SECTION CAN BE USED IN readme.cli.md
      cmderr	[Autorest] --------------------------------------------------------
      cmderr	[Autorest]   test-scenario:
      cmderr	[Autorest]     - name: /Monitors/put/Monitors_Create
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_Get
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_List
      cmderr	[Autorest]     - name: /Monitors/get/Monitors_ListByResourceGroup
      cmderr	[Autorest]     - name: /Monitors/patch/Monitors_Update
      cmderr	[Autorest]     - name: /DeploymentInfo/post/DeploymentInfo_List
      cmderr	[Autorest]     - name: /MonitoredResources/post/MonitoredResources_List
      cmderr	[Autorest]     - name: /TagRules/put/TagRules_CreateOrUpdate
      cmderr	[Autorest]     - name: /TagRules/get/TagRules_Get
      cmderr	[Autorest]     - name: /TagRules/get/TagRules_List
      cmderr	[Autorest]     - name: /TagRules/delete/TagRules_Delete
      cmderr	[Autorest]     - name: /VMCollection/post/VMCollection_Update
      cmderr	[Autorest]     - name: /VMHost/post/VMHost_List
      cmderr	[Autorest]     - name: /VMIngestion/post/VMIngestion_Details
      cmderr	[Autorest]     - name: /Monitors/delete/Monitors_Delete
      cmderr	[Autorest] --------------------------------------------------------
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi, @vakuncha your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @jianyexi
    Copy link
    Contributor

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 1 pipeline(s).

    @chunyu3
    Copy link
    Member

    chunyu3 commented Jun 29, 2021

    The breaking changes detected in 'cross version breaking change' is caused by update the enum value of 'ApiVersionParamter'. In the future, the service will use the ApiVersionParamter in common/types indead of the one defined in special swagger file. For this PR, just ignore these breaking changes.

    @vakuncha vakuncha force-pushed the vakuncha/movingelastictostable branch from bc670f3 to 67a6357 Compare June 29, 2021 09:37
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Jun 29, 2021
    @chunyu3 chunyu3 self-requested a review June 30, 2021 01:15
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    * Base Swagger version as per guideline
    
    * Removing preview from directory version
    
    * changing version name in all files
    
    * updating readme and go read me
    
    * supressing ingestion keyin read me
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants