[Test] Remove parameter schema #3678
Open
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
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
No pipelines are associated with this pull request. |
|
/azp run |
|
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
|
No pipelines are associated with this pull request. |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/openapi-env-test/azure-rest-api-specs/blob/070136c7eb806287d41b60fc9d1338988e501278/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2022-04-01-preview/workflow.json", "old":"https://github.com/openapi-env-test/azure-rest-api-specs/blob/main/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2022-04-01-preview/workflow.json", "details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 6 lines of stack trace follow, indexed. First line should contain AutoRest command line invocation details. Second line should contain the main message reported by AutoRest. ==================== 1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidationTest_1a18ed4f-f3bf-4f34-9fed-13cb57bd2410/0.0.367/common/temp/node_modules/.pnpm/@Azure[email protected]/node_modules/autorest/dist/app.js" --v2 --input-file=specification/developerhub/resource-manager/Microsoft.DevHub/preview/2022-04-01-preview/workflow.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp -------------------- 2: ERROR: Schema violation: Data does not match any schemas from 'oneOf' -------------------- 3: - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2022-04-01-preview/workflow.json:79:8 ($.paths["/subscriptions/subscriptionId/providers/Microsoft.DevHub/locations/location/githuboauth/default/getGitHubOAuthInfo"].post.parameters) -------------------- 4: FATAL: swagger-document/individual/schema-validator - FAILED -------------------- 5: FATAL: Error: [OperationAbortedException] Error occurred. Exiting. -------------------- 6: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting. --------------------" |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.1.6) | new version | base version |
|---|---|---|
| package-preview-2022-04 | package-preview-2022-04(070136c) | package-preview-2022-04(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Query parameter code should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L123 |
|
Query parameter state should be removed. Point Get's MUST not have query parameters other than api version. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L123 |
|
Get endpoints for collections of resources must only have the value and nextLink properties in their model.Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L182 |
|
The delete response body must be empty. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L402 |
|
Must not have duplicate name of x-ms-enum extension , make sure every x-ms-enum name unique. The duplicate x-ms-enum name: manifesttype, path: $['ManifestType'] Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L686 |
| The API version:2022-04-01-preview having been in a preview state over one year , please move it to GA or retire. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L4 |
|
| Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L38 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L47 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L54 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L60 |
|
| OperationId should contain the verb: 'getgithuboauthinfo' in:'GitHubOAuth'. Consider updating the operationId Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L77 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L81 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L84 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L87 |
|
| Parameter should have a description. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L89 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L105 |
|
| 'GET' operation 'GitHubOAuthCallback' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L121 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L125 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L128 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L131 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L150 |
|
| Since operation response has model definition in array type, it should be of the form '_list'. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L162 |
|
| Based on the response model schema, operation 'ListGitHubOAuth' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L162 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L170 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L173 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L176 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L189 |
|
| OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'WorkflowModel'. Consider using the plural form of 'Workflow' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L205 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L209 |
|
| Use the latest version v5 of types.json. Location: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L212 |
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️[NotRequired_Staging] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Missing required property: schema JsonUrl: Microsoft.DevHub/preview/2022-04-01-preview/workflow.json#L89:11 |
️️✔️~[NotRequired_Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️~[NotRequired_Staging] TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️[NotRequired_Staging] PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️[NotRequired_Staging] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️❌[NotRequired_Staging] SDK Track2 Validation: 1 Errors, 5 Warnings failed [Detail]
- The following tags are being changed in this PR
- "https://github.com/openapi-env-test/azure-rest-api-specs/blob/070136c7eb806287d41b60fc9d1338988e501278/specification/developerhub/resource-manager/readme.md#tag-package-preview-2022-04">developerhub/resource-manager/readme.md#package-preview-2022-04
| Rule | Message |
|---|---|
|
"readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"Must not have duplicate name of x-ms-enum extension , make sure every x-ms-enum name unique. The duplicate x-ms-enum name: manifesttype, path: $['ManifestType']" |
| "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"Based on the response model schema, operation 'Operations_List' might be pageable. Consider adding the x-ms-pageable extension." |
|
| "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"Based on the response model schema, operation 'ListGitHubOAuth' might be pageable. Consider adding the x-ms-pageable extension." |
|
| "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"OperationId should contain the verb: 'getgithuboauthinfo' in:'GitHubOAuth'. Consider updating the operationId" |
|
| "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"The API version:2022-04-01-preview having been in a preview state over one year , please move it to GA or retire." |
|
| "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: List Workflows" |
|
| 💬 | "readme":"developerhub/resource-manager/readme.md", "tag":"package-preview-2022-04", "details":"openapiValidatorPluginFunc: Validating 'file:///mnt/vss/_work/1/azure-rest-api-specs/specification/developerhub/resource-manager/Microsoft.DevHub/preview/2022-04-01-preview/workflow.json'" |
The following errors/warnings exist before current PR submission:
Swagger Generation Artifacts
|
Generated ApiView
|
|
/azp run |
|
Automatic PR validation restarted. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
Swagger Generation Artifacts
|
|
No pipelines are associated with this pull request. |
Generated ApiView
|
|
Automatic PR validation started. This comment will be populated with next steps to merge this PR once validation is completed. Please wait ⌛. |
Swagger Validation Report
|
Swagger Generation Artifacts
|
Generated ApiView
|
|
/azp run |
|
No pipelines are associated with this pull request. |
Swagger Validation Report
|
ankhyk
changed the title
ankhyk
changed the title
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.
Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.
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 appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
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.