doc and example fixes #21558
Merged
doc and example fixes #21558
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
davsta90
requested review from
markweitzel and
mikekistler
and removed request for
a team
|
Hi, @davsta90 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. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
"new":"https://github.com/Azure/azure-rest-api-specs/blob/5d5ed58a43c35a00e589a181bdca58b08681828f/specification/maps/data-plane/Creator/preview/2022-09-01-preview/wayfind.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/maps/data-plane/Creator/preview/2022-09-01-preview/wayfind.json", "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.45/common/temp/node_modules/.pnpm/@Azure+oad@0.10.2/node_modules/autorest/dist/app.js --v2 --input-file=specification/maps/data-plane/Creator/preview/2022-09-01-preview/wayfind.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=new --output-folder=/tmp\nERROR: Schema violation: Data does not match any schemas from 'oneOf'\n - file:///mnt/vss/_work/1/azure-rest-api-specs/specification/maps/data-plane/Creator/preview/2022-09-01-preview/wayfind.json:223:4 ($.parameters.AvoidFeatures)\nFATAL: swagger-document/individual/schema-validator - FAILED\nFATAL: Error: [OperationAbortedException] Error occurred. Exiting.\nProcess() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting.\n" |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 0 Warnings warning [Detail]
| compared tags (via openapi-validator v2.0.0) | new version | base version |
|---|---|---|
| package-preview-2022-09 | package-preview-2022-09(5d5ed58) | package-preview-2022-09(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
| Based on the response model schema, operation 'Wayfinding_GetPath' might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2022-09-01-preview/wayfind.json#L256 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: Creator/preview/2022-09-01-preview/wayfind.json#L256 |
|
| A required parameter should not specify a default value. Location: Creator/preview/2022-09-01-preview/wayfind.json#L268 |
|
| Error response should contain a x-ms-error-code header. Location: Creator/preview/2022-09-01-preview/wayfind.json#L303 |
|
The error property in the error response schema should be required.Location: Creator/preview/2022-09-01-preview/wayfind.json#L303 |
|
Error schema should define code and message properties as required.Location: Creator/preview/2022-09-01-preview/wayfind.json#L303 |
️️✔️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.
️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
| Rule | Message |
|---|---|
|
Expected type object but found type string JsonUrl: Creator/preview/2022-09-01-preview/wayfind.json#L236:13 |
️️✔️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.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
ghost
added
the
|
Hi @davsta90, Your PR has some issues. Please fix the CI sequentially by following the order of
|
tjprescott
approved these changes
Nov 15, 2022
…rting value NoExplanation to type 'System.Collections.Generic.Dictionary
tjprescott
added
FalsePositive-BreakingChange
Approved-SemanticValidation
Approved-BreakingChange
anandanthony
pushed a commit
to anandMicro/azure-rest-api-specs
that referenced
this pull request
Dec 16, 2022
* doc and example fixes * Prettier whitespace changes * trying to fix Newtonsoft.Json.JsonSerializationException: Error converting value NoExplanation to type 'System.Collections.Generic.Dictionary * attempting to fix validaiton errors * attempting to fix validaiton errors
kayousef-zz
pushed a commit
to kayousef-zz/azure-rest-api-specs
that referenced
this pull request
Dec 21, 2022
* doc and example fixes * Prettier whitespace changes * trying to fix Newtonsoft.Json.JsonSerializationException: Error converting value NoExplanation to type 'System.Collections.Generic.Dictionary * attempting to fix validaiton errors * attempting to fix validaiton errors
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
Just pushing doc fixes for the recently published preview of Wayfinding:
a. No API changes. No breaking changes
b. changed x-ms_enum to x-ms-enum: undetected error which prevent enum values being displayed in the doc
c. re-worded param description
d. fixed empty example