Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Updating examples for GetImages API to add details about paging.. #24030

Merged
merged 2 commits into from
Jul 31, 2023

Addressing PR comments. Added the a template for next link

557c017
Select commit
Loading
Failed to load commit list.
Merged

Updating examples for GetImages API to add details about paging.. #24030

Addressing PR comments. Added the a template for next link
557c017
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff succeeded Jul 26, 2023 in 4m 47s

Swagger LintDiff succeeded

LintDiff
View more details.

Details

compared tags (via openapi-validator v2.1.3) new version base version
package-2023-07-01 package-2023-07-01(557c017) package-2023-07-01(feature/cplat-2023-07-01)

The following errors/warnings exist before current PR submission:

Rule Message
❌ ResourceNameRestriction The resource name parameter 'imageName' should be defined with a 'pattern' restriction.
Location: ComputeRP/stable/2023-07-01/image.json#L37
❌ PutResponseSchemaDescription Description of 200 response code of a PUT operation MUST include term 'update'.
Location: ComputeRP/stable/2023-07-01/image.json#L75
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: ComputeRP/stable/2023-07-01/image.json#L91
❌ PatchResponseCode LRO PATCH must have 200 and 202 return codes.
Location: ComputeRP/stable/2023-07-01/image.json#L129
❌ LroPatch202 The async patch operation should return 202.
Location: ComputeRP/stable/2023-07-01/image.json#L166
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: ComputeRP/stable/2023-07-01/image.json#L182
❌ LroLocationHeader A 202 response should include an Location response header.
Location: ComputeRP/stable/2023-07-01/image.json#L225
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: ComputeRP/stable/2023-07-01/image.json#L234
❌ ParametersInPointGet Query parameter $expand should be removed. Point Get's MUST not have query parameters other than api version.
Location: ComputeRP/stable/2023-07-01/image.json#L254
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: ComputeRP/stable/2023-07-01/image.json#L44
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: ComputeRP/stable/2023-07-01/image.json#L135
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: ComputeRP/stable/2023-07-01/image.json#L199
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: ComputeRP/stable/2023-07-01/image.json#L254
⚠️ ParameterNotUsingCommonTypes Not using the common-types defined parameter 'resourceGroupName'.
Location: ComputeRP/stable/2023-07-01/image.json#L311
⚠️ EnumInsteadOfBoolean 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: ComputeRP/stable/2023-07-01/image.json#L516
View more details on openapi-pipeline-app