-
Notifications
You must be signed in to change notification settings - Fork 5.2k
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
[IoT - Device Provisioning] DataPlane API Review #15621
Conversation
Hi, @leigharubin Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vsswagger@microsoft.com |
[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. |
Swagger Validation Report
|
Swagger Generation Artifacts
|
Hi @leigharubin, Your PR has some issues. Please fix the CI sequentially by following the order of
|
Hi, @leigharubin. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a number of changes needed -- some minor but others more fundamental, like using the Azure error response body schema and pagination pattern.
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Outdated
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Outdated
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Outdated
Show resolved
Hide resolved
...ation/deviceprovisioningservices/data-plane/Microsoft.Devices/stable/2021-10-01/service.json
Show resolved
Hide resolved
@mikekistler is there a format / template for the README that is blocking this PR from merging? |
I found a sample readme file here: https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/92/Sample-ReadME I think (hope) that is what you need. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All my concerns have been addressed. 👍
@JeffreyRichter @markweitzel @johanste @tg-msft @rysweet This API was through the board and the notes are in #15694. I think the team has addressed the whatever issues they could without introducing breaking changes (the service is already GA -- this PR is just to get the API defn into the repo). Could we get one more thumbs up on this PR before we move it to approved? |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Scope of review is captured in #15694
Looks good. Thank you.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I wish the swagger was organized by HTTP methods (PUT, POST, GET, etc.). It should be organized by resource type instead.
@markweitzel Thank you! As noted in the PR, we will not be able to fix the "Swagger LintDiff" errors as this is a GA service but our first time uploading our swagger here, so fixing this would cause breaking changes. Could you please merge this PR without us needing to fix that automated check? @mikekistler said you could potentially help with this. Thanks! |
@leigharubin -- I don't have perms to do the merge but will ping @lmazuel who, I believe does have permission. |
@mikekistler if you are satisfied with the changes can you change your review to an approval? We should then be good to merge. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I am generally good with this except for my concern about simpler names. If we are going to create Azure SDK libraries for this service -- that appears to be the plan -- then this is our best opportunity to get the names right.
@mikekistler unfortunately due to needing to maintain back-compat when upgrading API versions, we will not be able to change these names as they will cause friction for the customer to upgrade to use new features. |
@leigharubin I don't think @mikekistler means changing the names in the service, but aliasing them for SDK generation with |
@tjprescott I see, I was misunderstanding at first. However, we already have many versions of SDKs generated so I believe the same issue applies here as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good! 👍
All my concerns have been addressed.
Seems like we have all the necessary approvals 👍 . Thanks @mikekistler and @JeffreyRichter. @lmazuel can you please merge this PR? Thanks! |
* Create service.json * Fix "expecting boolean, found string" issues * Update custom-words.txt * Create service.json * Update service.json * Add readme files * Delete readme.go.md * Delete readme.java.md * Delete readme.nodejs.md * Delete readme.python.md * Update readme.md * Create readme.go.md * Update readme.go.md * Update readme.go.md * Remove pattern and max length attributes * Update service.json * Delete readme.go.md * Create readme.go.md * Delete readme.go.md * Update readme.md
* Create service.json * Fix "expecting boolean, found string" issues * Update custom-words.txt * Create service.json * Update service.json * Add readme files * Delete readme.go.md * Delete readme.java.md * Delete readme.nodejs.md * Delete readme.python.md * Update readme.md * Create readme.go.md * Update readme.go.md * Update readme.go.md * Remove pattern and max length attributes * Update service.json * Delete readme.go.md * Create readme.go.md * Delete readme.go.md * Update readme.md
MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Contribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following apply to the PR so that label “WaitForARMFeedback” will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.
-[ ] To review changes efficiently, ensure you copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
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 any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
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.