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

Windows IoT Swagger: Return 201 on Create Response #12610

Merged
merged 1 commit into from
Jan 29, 2021
Merged

Windows IoT Swagger: Return 201 on Create Response #12610

merged 1 commit into from
Jan 29, 2021

Conversation

adithyaj
Copy link
Contributor

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: Currrently on Service_Create we return a 201, updating swagger to match this behavior.
  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. N/A
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet. N/A
  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 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, @adithyaj 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 Jan 25, 2021 •
    edited
    Loading

    Swagger Validation Report

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

    Rule Message
    ❌ 1011 - AddingResponseCode The new version adds a response code '201'.
    New: Microsoft.WindowsIoT/stable/2019-06-01/WindowsIotServices.json#L159:11
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 25, 2021 •
    edited
    Loading

    Swagger Generation Artifacts

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f67fb5d. 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
    • ️✔️windowsiot/mgmt/2019-06-01/windowsiot [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
info	[Changelog]
info	[Changelog] - Function `ServicesClient.UpdatePreparer` parameter(s) have been changed from `(context.Context, string, string, DeviceServiceProperties, string)` to `(context.Context, string, string, DeviceService, string)`
info	[Changelog] - Function `ServicesClient.CreateOrUpdatePreparer` parameter(s) have been changed from `(context.Context, string, string, DeviceServiceProperties, string)` to `(context.Context, string, string, DeviceService, string)`
info	[Changelog] - Function `ServicesClient.CreateOrUpdate` parameter(s) have been changed from `(context.Context, string, string, DeviceServiceProperties, string)` to `(context.Context, string, string, DeviceService, string)`
info	[Changelog] - Function `ServicesClient.Update` parameter(s) have been changed from `(context.Context, string, string, DeviceServiceProperties, string)` to `(context.Context, string, string, DeviceService, string)`
info	[Changelog] - Field `Code` of struct `ErrorDetails` has been removed
info	[Changelog] - Field `Message` of struct `ErrorDetails` has been removed
info	[Changelog] - Field `Target` of struct `ErrorDetails` has been removed
info	[Changelog] - Field `Details` of struct `ErrorDetails` has been removed
info	[Changelog]
info	[Changelog] ### New Content
info	[Changelog]
info	[Changelog] - New struct `ErrorDetailsError`
info	[Changelog] - New field `Error` in struct `ErrorDetails`
info	[Changelog] - New field `IsDataAction` in struct `OperationEntity`
info	[Changelog]
info	[Changelog] Total 5 breaking change(s), 4 additive change(s).
info	[Changelog]
    ️️✔️ azure-cli-extensions succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f67fb5d. 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/windowsiot/resource-manager/readme.md
cmdout	[Autorest] WARNING (PreCheck/AllOfWhenYouMeantRef): Schema 'ProxyResource' is using an 'allOf' instead of a $ref. This creates a wasteful anonymous type when generating code.
cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'Resource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'TrackedResource' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ProxyResource' with an undefined type and 'allOf'/'anyOf'/'oneOf' is a bit ambigious. This has been auto-corrected to 'type:object'
cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'OperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
cmdout	[Autorest] WARNING (PreCheck/SchemaMissingType): The schema 'ErrorDetails' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'
cmdout	[Autorest] WARNING (PreCheck/CheckDuplicateSchemas): Checking for duplicate schemas, this could take a (long) while.  Run with --verbose for more detail.
cmdout	[Autorest] WARNING (): Operation Update has already existed in group! Skip split!
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: /Services/put/Service_Create
cmderr	[Autorest]     - name: /Services/get/Service_List
cmderr	[Autorest]     - name: /Services/get/Service_ListByResourceGroup
cmderr	[Autorest]     - name: /Services/get/Services_GetProperties
cmderr	[Autorest]     - name: /Services/patch/Service_Update
cmderr	[Autorest]     - name: /Services/post/Service_CheckNameAvailability
cmderr	[Autorest]     - name: /Services/delete/Service_Delete
cmderr	[Autorest] --------------------------------------------------------
cmderr	[Autorest] /bin/sh: 1: cd: can't cd to home/vsts/work/1/s/azure-rest-api-specs
cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
cmderr	[Autorest] fatal: not a git repository (or any of the parent directories): .git
    • ️✔️windowsiot [View full logs]  [Release Azure CLI Changes]
    ️❌ azure-sdk-for-python failed [Detail]
    • ❌Failed [Logs]Release - Generate from f67fb5d. 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 wrapt
cmderr	[automation_init.sh]   Failed building wheel for yarl
cmderr	[automation_init.sh]   Failed building wheel for multidict
cmderr	[automation_init.sh] Cannot uninstall requirement azure-nspkg, not installed
cmderr	[automation_init.sh] Command '['/home/vsts/work/1/s/azure-sdk-for-python_tmp/venv-sdk/bin/python', '-m', 'pip', 'uninstall', '-y', 'azure-nspkg']' 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
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-net succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from f67fb5d. 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/windowsiot/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.WindowsIoT [View full logs]  [Release SDK Changes] 
      warn	Skip artifact folder because it doesn't exist: artifacts/packages
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f67fb5d. 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-01-29 06:20:17 INFO [VERSION][Not Found] cannot find version for "com.azure.resourcemanager:azure-resourcemanager-windowsiot"
cmderr	[generate.py] 2021-01-29 06:20:17 INFO [VERSION][Not Found] cannot find stable version, current version "1.0.0-beta.1"
cmderr	[generate.py] 2021-01-29 06:20: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/windowsiot/azure-resourcemanager-windowsiot --java.namespace=com.azure.resourcemanager.windowsiot   --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/windowsiot/resource-manager/readme.md
cmderr	[generate.py] 2021-01-29 06:20:50 INFO [CI][Success] Write to ci.yml
cmderr	[generate.py] 2021-01-29 06:20:50 INFO [POM][Process] dealing with pom.xml
cmderr	[generate.py] 2021-01-29 06:20:50 INFO [POM][Skip] pom already has module azure-resourcemanager-windowsiot
cmderr	[generate.py] 2021-01-29 06:20:50 INFO [POM][Success] Write to pom.xml
cmderr	[generate.py] 2021-01-29 06:20:50 INFO [POM][Process] dealing with root pom
cmderr	[generate.py] 2021-01-29 06:20:50 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-windowsiot [View full logs]  [Release SDK Changes] 
      cmderr	[Inst] 2021-01-29 06:22:53 DEBUG Got artifact_id: azure-resourcemanager-windowsiot
cmderr	[Inst] 2021-01-29 06:22:53 DEBUG Got artifact: pom.xml
cmderr	[Inst] 2021-01-29 06:22:53 DEBUG Got artifact: azure-resourcemanager-windowsiot-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 06:22:53 DEBUG Match jar package: azure-resourcemanager-windowsiot-1.0.0-beta.1.jar
cmderr	[Inst] 2021-01-29 06:22:53 DEBUG output: {"full": "```sh\ncurl -L \"https://portal.azure-devex-tools.com/api/sdk-dl-pub?p=Azure/12610/azure-sdk-for-java/azure-resourcemanager-windowsiot/azure-resourcemanager-windowsiot-1.0.0-beta.1.jar\" -o azure-resourcemanager-windowsiot-1.0.0-beta.1.jar\nmvn install:install-file -DgroupId=com.azure.resourcemanager -DartifactId=azure-resourcemanager-windowsiot -Dversion=1.0.0-beta.0 -Dfile=azure-resourcemanager-windowsiot-1.0.0-beta.1.jar -Dpackaging=jar -DgeneratePom=true
```"}
    ️⚠️ azure-sdk-for-js warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from f67fb5d. 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/windowsiot/resource-manager/readme.md
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 f67fb5d. 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/windowsiot/resource-manager/readme.md
    • ️✔️windowsiot [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"})
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand] 
     Please click here to preview with your @microsoft account.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @adithyaj, 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.

    This was referenced Jan 25, 2021
    Closed
    Closed
    This was referenced Jan 25, 2021
    Draft
    Closed
    Closed
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Jan 25, 2021
    @adithyaj
    Copy link
    Contributor Author

    @qianwens The breaking changes were approved and all checks have passed. Could you take a look at this?

    @qianwens qianwens merged commit f67fb5d into Azure:master Jan 29, 2021
    This was referenced Jan 29, 2021
    Closed
    Closed
    Merged
    Closed
    Closed
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    @adithyaj @mkarmark
    201 Create Push (Azure#12610)
    6afe66b 
    Co-authored-by: Adithya Jayachandran <adjayach@microsoft.com>
    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

    Assignees

    @qianwens qianwens

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

    Successfully merging this pull request may close these issues.
    3 participants
    @adithyaj @JeffreyRichter @qianwens