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

nginx: configurationName can only ever be default (per the API/docs) so hardcoding this value #26883

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

`nginx`: `configurationName` can only ever be `default` (per the API/…

9d0699a
Select commit
Loading
Failed to load commit list.
Open

nginx: configurationName can only ever be default (per the API/docs) so hardcoding this value #26883

`nginx`: `configurationName` can only ever be `default` (per the API/…
9d0699a
Select commit
Loading
Failed to load commit list.
openapi-pipeline-app / Swagger LintDiff failed Nov 29, 2023 in 2m 51s

Swagger LintDiff failed

LintDiff: 52 Errors, 164 Warnings
View more details.

Details

compared tags (via openapi-validator v2.1.6) new version base version
package-2023-04-01 package-2023-04-01(9d0699a) package-2023-04-01(main)
package-2022-08-01 package-2022-08-01(9d0699a) package-2022-08-01(main)

[must fix]The following errors/warnings are introduced by current PR:

Rule Message Related RPC [For API reviewers]
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L302		 RPC-Uri-V1-05
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L396
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L410		 RPC-Delete-V1-01
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L437		 RPC-Async-V1-07
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L446
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L302		 RPC-Uri-V1-05
❌ RequestSchemaForTrackedResourcesMustHaveTags A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L346
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L396
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L410		 RPC-Delete-V1-01
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L437		 RPC-Async-V1-07
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L446
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L314
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L317
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L323
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L360
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L363
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L369
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L421
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L424
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L430
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L314
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L317
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L323
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L360
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L363
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L369
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L421
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L424
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L430


The following errors/warnings exist before current PR submission:
Only 50 items are listed, please refer to log for more details.

Rule Message
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L29
❌ ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L29
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L137
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L151
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L185
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L194
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L206
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L254
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L458
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L551
❌ PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L565
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L590
❌ LroPatch202 The async patch operation should return 202.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L598
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L614
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L625
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L652
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L661
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L779
❌ TrackedResourcePatchOperation Tracked resource 'NginxCertificate' must have patch operation that at least supports the update of tags.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L837
❌ TrackedResourcePatchOperation Tracked resource 'NginxConfiguration' must have patch operation that at least supports the update of tags.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L932
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L29
❌ ResourceNameRestriction The resource name parameter 'certificateName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L29
❌ RequestSchemaForTrackedResourcesMustHaveTags A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L80
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L137
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L151
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L185
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L194
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L206
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L254
❌ ResourceNameRestriction The resource name parameter 'deploymentName' should be defined with a 'pattern' restriction.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L458
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L551
❌ PatchResponseCodes Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L565
❌ UnSupportedPatchProperties Mark the top-level property 'location', specified in the patch operation body, as readOnly or immutable. You could also choose to remove it from the request payload of the Patch operation. These properties are not patchable.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L590
❌ LroPatch202 The async patch operation should return 202.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L598
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L614
❌ DeleteResponseCodes Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L625
❌ LroLocationHeader A 202 response should include an Location response header.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L652
❌ LroErrorContent Error response content of long running operations must follow the error schema provided in the common types v2 and above.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L661
❌ OperationsApiSchemaUsesCommonTypes Operations API path must follow the schema provided in the common types.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L779
❌ TrackedResourcePatchOperation Tracked resource 'NginxCertificate' must have patch operation that at least supports the update of tags.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L837
❌ TrackedResourcePatchOperation Tracked resource 'NginxConfiguration' must have patch operation that at least supports the update of tags.
Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L933
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L41
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L44
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L57
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L94
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L97
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L110
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L162
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L165
⚠️ LatestVersionOfCommonTypesMustBeUsed Use the latest version v5 of types.json.
Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L178
View more details on openapi-pipeline-app