SIP-Update formatting of security section #23952
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
…in generated documentation
dzeliar
requested review from
JeffreyRichter and
MushMal
and removed request for
a team
|
Hi, @dzeliar 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 |
|---|---|---|
| communicationservicessiprouting.json | 2023-04-01-preview(e8922cc) | 2023-04-01-preview(main) |
| communicationservicessiprouting.json | 2023-03-01(e8922cc) | 2023-03-01(main) |
️️✔️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.1.1) | new version | base version |
|---|---|---|
| package-preview-2023-04 | package-preview-2023-04(e8922cc) | package-preview-2023-04(main) |
| package-2023-03 | package-2023-03(e8922cc) | package-2023-03(main) |
The following errors/warnings exist before current PR submission:
| Rule | Message |
|---|---|
|
The parameter 'ApiVersionParameter' 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: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L530 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L578 |
|
The parameter 'ApiVersionParameter' 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: SipRouting/stable/2023-03-01/communicationservicessiprouting.json#L211 |
|
The host parameter must be typed 'type 'string', format 'url''. Location: SipRouting/stable/2023-03-01/communicationservicessiprouting.json#L259 |
| Based on the response model schema, operation 'SipRouting_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L13 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L13 |
|
| The body parameter is not marked as required. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L75 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L112 |
|
| The body parameter is not marked as required. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L136 |
|
| Error response should contain a x-ms-error-code header. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L152 |
|
| Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum. Location: SipRouting/preview/2023-04-01-preview/communicationservicessiprouting.json#L407 |
|
| Based on the response model schema, operation 'SipRouting_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/stable/2023-03-01/communicationservicessiprouting.json#L13 |
|
| Operation might be pageable. Consider adding the x-ms-pageable extension. Location: SipRouting/stable/2023-03-01/communicationservicessiprouting.json#L13 |
|
| The body parameter is not marked as required. Location: SipRouting/stable/2023-03-01/communicationservicessiprouting.json#L69 |
️️✔️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 pipeline restarted successfully, please wait for status update in this comment. |
Generated ApiView
|
|
/azp run |
|
Azure Pipelines successfully started running 1 pipeline(s). |
|
|
@hello @JeffreyRichter, thank you for review, we'll keep your notes for the next iteration of preview of this API. |
|
Hello @JeffreyRichter, did you have a change to have a look at my previous comment? Is this change possible? Thank you |
JeffreyRichter
approved these changes
May 18, 2023
|
I approved this PR |
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
Update formatting of security section to properly generate documentation. In documentation review process we discovered apiKey authentication has been missing. This PR updates the definition to include both user_impersonation & apiKey.
API Info: The Basics
Ticket tracking documentation https://dev.azure.com/ceapex/Onboarding/_workitems/edit/815841
Is this review for (select one):
Change Scope
No functional changes
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.
❔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