Add data-plane 2023-06-30 for Azure Digital Twins #23616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
abhinav-ghai
requested review from
markweitzel and
vicancy
and removed request for
a team
|
Hi, @abhinav-ghai 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. [email protected] |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| digitaltwins.json | 2023-06-30(5c3b94b) | 2022-05-31(main) |
| digitaltwins.json | 2023-06-30(5c3b94b) | 2023-02-27-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.1) | new version | base version |
|---|---|---|
| package-2023-06-30 | package-2023-06-30(5c3b94b) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Per the Noun_Verb convention for Operation Ids, the noun 'Query' 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.DigitalTwins/stable/2023-06-30/digitaltwins.json#L298 |
|
The schema 'ErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L1936 |
|
The schema 'Error' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L1948 |
|
The schema 'InnerError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L1975 |
|
The parameter 'api-version' is defined in global parameters section without 'x-ms-parameter-location' extension. This would add the parameter as the client property. Please ensure that this is exactly you want. If so, apply the extension 'x-ms-parameter-location': 'client'. Else, apply the extension 'x-ms-parameter-location': 'method'. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L2054 |
|
The integer type does not have a format, please add it. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L2062 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L2074 |
| Using post for a create operation is discouraged. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L59 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L73 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L133 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L164 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L189 |
|
| A patch operation should consume 'application/merge-patch+json' content type. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L201 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L210 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L241 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L259 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L278 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L294 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L294 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L349 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L377 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L405 |
|
| A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'DigitalTwins_Add' Request Model: 'parameters[1].schema' Response Model: 'responses[200].schema' Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L411 |
|
| OperationId for put method should contain 'Create' or 'Update' Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L415 |
|
| 'PUT' operation 'DigitalTwins_Add' 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.DigitalTwins/stable/2023-06-30/digitaltwins.json#L415 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L426 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L466 |
|
| Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L484 |
|
Error schema should define code and message properties as required.Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L506 |
|
| A patch operation should consume 'application/merge-patch+json' content type. Location: Microsoft.DigitalTwins/stable/2023-06-30/digitaltwins.json#L518 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️⚠️~[Staging] ServiceAPIReadinessTest: 0 Warnings warning [Detail]
API Test is not triggered due to precheck failure. Check pipeline log for details.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️CadlValidation succeeded [Detail] [Expand]
Validation passes for CadlValidation.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
Swagger Generation Artifacts
|
Generated ApiView
|
|
Hi, @abhinav-ghai, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline |
This was referenced Apr 18, 2023
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
This was referenced May 9, 2023
markweitzel
approved these changes
May 17, 2023
mikekistler
added
the
APIStewardshipBoard-SignedOff
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Data Plane API - Pull Request
Add new API version 2023-06-30 for data plane APIs of Azure Digital Twins
API Info: The Basics
Most of the information about your service should be captured in the issue that serves as your [API Spec engagement record](https://aka.ms/azsdk/onboarding/restapischedule).
We are taking changes from public preview to GA, the only changes are in /jobs/imports path, which is going GA, other API is same as pevious.
https://github.com/Azure/azure-rest-api-specs-pr/pull/10145
Is this review for (select one):
Change Scope
This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous API Spec document (if applicable), and the root paths that have been updated.
Previous Open API Doc: 2023-02-27-preview
Bulk Import API Review doc. https://microsoft.sharepoint.com/:w:/t/DanHellem/EUaFSi42pHJNlQNlLaEXkNQBPE6xvqmfpdEs7Rr5DxbknA?e=Ov1Jcj
❔Got questions? Need additional info?? We are here to help!
Contact us!
The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.
Click here for links to tools, specs, guidelines & other good stuff
Tooling
Guidelines & Specifications
Helpful Links
fix #23657