Move swagger json file out of definitions folder #16700
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
* Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo
|
Hi, @sureleo 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 |
Swagger Validation Report
|
| Rule | Message |
|---|---|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-11-01/azurearcdata.json#L733 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-11-01/azurearcdata.json#L796 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-11-01/azurearcdata.json#L844 |
|
| Per the Noun_Verb convention for Operation Ids, the noun 'DataControllers' 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.AzureArcData/stable/2021-11-01/azurearcdata.json#L888 |
|
| 'PUT' operation 'DataControllers_PutDataController' 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.AzureArcData/stable/2021-11-01/azurearcdata.json#L733 |
|
| 'PATCH' operation 'DataControllers_PatchDataController' should use method name 'Update'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L888 |
|
| The enum types should have x-ms-enum type extension set with appropriate options. Property name: name Location: Microsoft.AzureArcData/stable/2021-11-01/sqlManagedInstances.json#L41 |
|
| Guid used in model definition 'UploadServicePrincipal' for property 'clientId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L198 |
|
| Guid used in model definition 'LogAnalyticsWorkspaceConfig' for property 'workspaceId'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L178 |
|
| Guid used in model definition 'OnPremiseProperty' for property 'id'. Usage of Guid is not recommanded. If GUIDs are absolutely required in your service, please get sign off from the Azure API review board. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L155 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: dev Location: Microsoft.AzureArcData/stable/2021-11-01/sqlManagedInstances.json#L61 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isDataAction Location: Microsoft.AzureArcData/stable/2021-11-01/operations.json#L35 |
|
| The tracked resource, 'DataControllerResource', must have a list by resource group operation.(This rule does not apply for tenant level resources.) Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L10 |
|
| The tracked resource, 'DataControllerResource', must have a list by subscriptions operation. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L10 |
|
| 'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L751 |
|
| 'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L805 |
|
| 'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L853 |
|
| 'dataControllerName' parameter lacks 'description' property. Consider adding a 'description' element. Accurate description is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L897 |
|
| 'PageOfDataControllerResource' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L33 |
|
| 'provisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L116 |
|
| 'value' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/dataControllers.json#L36 |
|
| 'provisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/sqlServerInstances.json#L145 |
|
| 'family' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/sqlManagedInstances.json#L70 |
|
| 'capacity' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/sqlManagedInstances.json#L73 |
|
| 'provisioningState' model/property lacks 'description' and 'title' property. Consider adding a 'description'/'title' element. Accurate description/title is essential for maintaining reference documentation. Location: Microsoft.AzureArcData/stable/2021-11-01/sqlManagedInstances.json#L115 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Updates a SQL Server Instance tags. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L533 |
|
| Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: Updates a SQL Server Instance tags. Location: Microsoft.AzureArcData/stable/2021-11-01/azurearcdata.json#L640 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️~[Staging] ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
️️✔️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).
Swagger Generation Artifacts
|
|
[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. |
|
Hi @sureleo, Your PR has some issues. Please fix the CI sequentially by following the order of
|
This was referenced Nov 8, 2021
This was referenced Nov 8, 2021
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
leni-msft
approved these changes
Nov 9, 2021
This was referenced Nov 9, 2021
Closed
This was referenced Nov 9, 2021
LeiWang3
pushed a commit
to LeiWang3/azure-rest-api-specs
that referenced
this pull request
Mar 31, 2022
* IoT Central Public API 1.1-preview Oct Release (Azure#16514) * Add new 2.0-preview.1 version for IoT Central * fix typo on enum value * rollback 1.0 changes, applied 2.0-preview.1 * fix typo * remove non-used examples * fix style * update version from 2.0-preview.1 to 1.1-preview * update code review comments, fix patch consumes with json-patch support, fix examples for fileupload * add nextLink to collection of orgs * fix typo * fix wrong position of paging * fix the paging * add . to description * update default to use enum for api-version * add oct release with query, cde v2, device filter, device template filter, relationship, edge template, simplified template patching * update examples * fix lint error, model validation * fix missing type in examples, remove url format * fix ID case * fix id case * fix ID case * add iotc query language reference * fix typo * Move things out of definitions * remove ../ Co-authored-by: Johnson Yang <hayang@microsoft.com>
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.
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.