-
Notifications
You must be signed in to change notification settings - Fork 5.1k
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.
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
nginx
: configurationName
can only ever be default
(per the API/docs) so hardcoding this value
#26883
base: main
Are you sure you want to change the base?
nginx
: configurationName
can only ever be default
(per the API/docs) so hardcoding this value
#26883
Conversation
…docs) so hardcoding this value
Next Steps to MergeNext steps that must be taken to merge this PR:
|
Swagger Validation Report
|
compared swaggers (via Oad v0.10.4)] | new version | base version |
---|---|---|
swagger.json | 2022-08-01(9d0699a) | 2022-08-01(main) |
swagger.json | 2023-04-01(9d0699a) | 2023-04-01(main) |
Rule | Message |
---|---|
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}' removed or restructured? Old: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L302:5 |
1005 - RemovedPath |
The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Nginx.NginxPlus/nginxDeployments/{deploymentName}/configurations/{configurationName}' removed or restructured? Old: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L302:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L302:5 |
1038 - AddedPath |
The new version is adding a path that was not found in the old version. New: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L302:5 |
️️✔️
Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️
CredScan succeeded [Detail] [Expand]
There is no credential detected.
️❌
LintDiff: 11 Errors, 18 Warnings failed [Detail]
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 |
|
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L314 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L317 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L323 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L360 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L363 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L369 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L421 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L424 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2022-08-01/swagger.json#L430 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L314 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L317 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L323 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L360 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L363 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L369 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L421 |
||
Use the latest version v5 of types.json. Location: NGINX.NGINXPLUS/stable/2023-04-01/swagger.json#L424 |
||
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 30 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 |
️️✔️
Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌
SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️
TypeSpecAPIView succeeded [Detail] [Expand]
️❌
ModelValidation: 6 Errors, 0 Warnings failed [Detail]
️️✔️
SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️
PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️
SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️
Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️
PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️
Automated merging requirements met succeeded [Detail] [Expand]
Swagger Generation Artifacts
|
Generated ApiView
|
Thank you for your contribution tombuildsstuff! We will review the pull request and get back to you soon. |
Please address or respond to feedback from the ARM API reviewer. |
ARM (Control Plane) API Specification Update Pull Request
PR review workflow diagram
Please understand this diagram before proceeding. It explains how to get your PR approved & merged.
Click here to see the details of Step 1
Breaking changes review (Diagram Step 1)
If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
you must follow the breaking changes process.
IMPORTANT This applies even if:
Such claims must be reviewed, and the process is the same.
Click here to see the details of Step 2
ARM API changes review (Diagram Step 2)
ARMReview
label.Click here to see the diagram footnotes
Diagram footnotes
[1] ARM review queue (for merge queues, see [2])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label
ARMChangesRequested
is removed from your PR. This should cause the label
WaitForARMFeedback
to be added.[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
If you need further help with anything, see
Getting help
section below.Purpose of this PR
What's the purpose of this PR? Check all that apply. This is mandatory!
configurationName
can only ever be set todefault
- therefore this isn't a configurable value and shouldn't be exposed as such. This is leading to this known issue within Nginx because the API only allows a single value forconfigurationName
(causing this issue).Due diligence checklist
To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:
ARM resource provider contract and
REST guidelines (estimated time: 4 hours).
I understand this is required before I can proceed to the Diagram Step 2, "ARM API changes Review", for this PR.
Additional information
Viewing API changes
For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the
Generated ApiView
comment added to this PR. You can use ApiView to show API versions diff.Suppressing failures
If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.
Getting help
and https://aka.ms/ci-fix.
queued
state, please add a comment with contents/azp run
.This should result in a new comment denoting a
PR validation pipeline
has started and the checks should be updated after few minutes.