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

Fix examples to include ExpandRegistrationDefinition field in public docs #12823

Merged
merged 2 commits into from
Feb 8, 2021
Merged

Fix examples to include ExpandRegistrationDefinition field in public docs #12823

merged 2 commits into from
Feb 8, 2021

Conversation

serenaz
Copy link
Contributor

@serenaz serenaz commented Feb 4, 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
    • [x ] Other, please clarify - fix for public docs
  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
    • [x ] 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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, @serenaz 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 Feb 4, 2021 •
    edited
    Loading

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️️✔️LintDiff succeeded [Detail] [Expand] 
    Validation passes for LintDiff.
    ️️✔️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 succeeded [Detail] [Expand] 
    Validation passes for SDKTrack2Validation
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 4, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 70d28b2. 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/managedservices/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.ManagedServices [View full logs]  [Release SDK Changes]
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 70d28b2. 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.4.4 --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/managedservices/resource-manager/readme.md
warn	No file changes detected after generation
warn	No package detected after generation
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 70d28b2. 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
    • ️✔️managedservices/mgmt/2019-06-01/managedservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️preview/managedservices/mgmt/2019-04-01/managedservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    • ️✔️preview/managedservices/mgmt/2018-06-01/managedservices [View full logs]  [Release SDK Changes] 
      info	[Changelog] No exported changes
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 70d28b2. 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-02-08 05:09:17 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-managedservices"
cmderr	[generate.py] 2021-02-08 05:09:17 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-02-08 05:09:17 INFO autorest --version=3.0.6350 --use=@autorest/java@4.0.11 --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/managedservices/azure-resourcemanager-managedservices --java.namespace=com.azure.resourcemanager.managedservices   --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/managedservices/resource-manager/readme.md
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [POM][Skip] pom already has module azure-resourcemanager-managedservices
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-02-08 05:09:58 INFO [POM][Success] Write to root pom
cmderr	[generate.py] WARNING: An illegal reflective access operation has occurred
cmderr	[generate.py] WARNING: Illegal reflective access by org.codehaus.groovy.reflection.ReflectionUtils (file:/home/vsts/.m2/repository/org/codehaus/groovy/groovy/3.0.0-beta-2/groovy-3.0.0-beta-2-indy.jar) to method java.util.Collections$UnmodifiableCollection.toString()
cmderr	[generate.py] WARNING: Please consider reporting this to the maintainers of org.codehaus.groovy.reflection.ReflectionUtils
cmderr	[generate.py] WARNING: Use --illegal-access=warn to enable warnings of further illegal reflective access operations
cmderr	[generate.py] WARNING: All illegal access operations will be denied in a future release
    • ️✔️azure-resourcemanager-managedservices [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-02-08 05:12:26 DEBUG Got artifact_id: azure-resourcemanager-managedservices
cmderr	[Inst] 2021-02-08 05:12:26 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-02-08 05:12:26 DEBUG Got artifact: azure-resourcemanager-managedservices-1.0.0-beta.1.jar
cmderr	[Inst] 2021-02-08 05:12:26 DEBUG Match jar package: azure-resourcemanager-managedservices-1.0.0-beta.1.jar
cmderr	[Inst] 2021-02-08 05:12:26 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12823/azure-sdk-for-java/azure-resourcemanager-managedservices/azure-resourcemanager-managedservices-1.0.0-beta.1.jar\" -o azure-resourcemanager-managedservices-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-managedservices -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-managedservices-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️⚠️ azure-sdk-for-python warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 70d28b2. 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] Ignoring mock: markers 'python_version <= "2.7"' don't match your environment
cmderr	[automation_init.sh]   Failed building wheel for ConfigArgParse
cmderr	[automation_init.sh]   Failed building wheel for yarl
cmderr	[automation_init.sh]   Failed building wheel for wrapt
cmderr	[automation_init.sh]   Failed building wheel for multidict
cmderr	[automation_init.sh] Command "python setup.py egg_info" failed with error code 1 in /home/vsts/work/1/s/azure-sdk-for-python_tmp/pip-build-3bzrj9xu/cryptography/
cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'install', '--ignore-requires-python', '-e', 'tools/azure-sdk-tools']' returned non-zero exit status 1.
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!!!
warn	File azure-sdk-for-python_tmp/generateOutput.json not found to read
warn	No file changes detected after generation
warn	No package detected after generation
    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 70d28b2. Schema Automation 14.0.0 
      warn	Skip initScript due to not configured
command	npx n 12
command	autorest --use=@autorest/azureresourceschema@3.0.92 --version=3.0.6369 --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/managedservices/resource-manager/readme.md
    • ️✔️managedservices [View full logs]  [Release Schema Changes] 
      cmderr	[resource-manager] node-pre-gyp
cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
cmderr	[resource-manager] WARN template-schema-validation-tools@1.0.0 No repository field.
cmderr	[resource-manager] WARN optional SKIPPING OPTIONAL DEPENDENCY: fsevents@2.1.3 (node_modules/fsevents):
cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for fsevents@2.1.3: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
cmderr	[resource-manager]  ELIFECYCLE
cmderr	[resource-manager] npm ERR! errno 11
cmderr	[resource-manager]  template-schema-validation-tools@1.0.0 test: `mocha -r ts-node/register tests.ts`
cmderr	[resource-manager] npm ERR! Exit status 11
cmderr	[resource-manager] npm
cmderr	[resource-manager] npm ERR! Failed at the template-schema-validation-tools@1.0.0 test script.
cmderr	[resource-manager] npm ERR! This is probably not a problem with npm. There is likely additional logging output above.
cmderr	[resource-manager]  A complete log of this run can be found in:
cmderr	[resource-manager] npm ERR!     /home/vsts/.npm/_logs/2021-02-08T05_08_57_313Z-debug.log
cmderr	[resource-manager] Error: Command failed: npm run test --prefix tools
cmderr	[resource-manager]     at checkExecSyncError (child_process.js:635:11)
cmderr	[resource-manager]     at Object.execSync (child_process.js:671:15)
cmderr	[resource-manager]     at Object.<anonymous> (/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas/sdkauto_afterscript.js:13:28)
cmderr	[resource-manager]     at Module._compile (internal/modules/cjs/loader.js:999:30)
cmderr	[resource-manager]     at Object.Module._extensions..js (internal/modules/cjs/loader.js:1027:10)
cmderr	[resource-manager]     at Module.load (internal/modules/cjs/loader.js:863:32)
cmderr	[resource-manager]     at Function.Module._load (internal/modules/cjs/loader.js:708:14)
cmderr	[resource-manager]     at Function.executeUserEntryPoint [as runMain] (internal/modules/run_main.js:60:12)
cmderr	[resource-manager]     at internal/main/run_main_module.js:17:47 {
cmderr	[resource-manager]   status: 11,
cmderr	[resource-manager]   signal: null,
cmderr	[resource-manager]   output: [ null, null, null ],
cmderr	[resource-manager]   pid: 2951,
cmderr	[resource-manager]   stdout: null,
cmderr	[resource-manager]   stderr: null
cmderr	[resource-manager] }
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
    Posted by Swagger Pipeline | How to fix these errors?

    This was referenced Feb 4, 2021
    Closed
    Draft
    Closed
    Closed
    @jianyexi jianyexi merged commit 70d28b2 into Azure:master Feb 8, 2021
    This was referenced Feb 8, 2021
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @serenaz @mkarmark
    Fix examples to include ExpandRegistrationDefinition field in public …
    e782516 
    …docs (Azure#12823)

* Add expand definition parameter

* Added expand definition parameter
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jianyexi jianyexi jianyexi approved these changes

    Assignees

    @jianyexi jianyexi

    Labels
    None yet
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    2 participants
    @serenaz @jianyexi