Praveen test doc changes #3328
Open
Praveen test doc changes #3328
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
mgmt_tsp_automation_conf
switch java branch override
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from preview/2023-09-01-preview to preview/2024-05-01-preview.
Next Steps to mergeNext steps that must be taken to merge this PR:
|
Swagger Generation Artifacts
|
Generated ApiView
|
Swagger Validation Report
|
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| appconfiguration.json | 2024-05-01-preview(3da07d9) | 2023-03-01(main) |
| appconfiguration.json | 2024-05-01-preview(3da07d9) | 2023-09-01-preview(main) |
️⚠️LintDiff: 0 Warnings warning [Detail]
| Compared specs (v2.2.0) | new version | base version |
|---|---|---|
| package-preview-2024-05 | package-preview-2024-05(3da07d9) | default(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L199 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L222 |
|
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L246 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L255 |
|
Long-running PATCH operations must have responses with 200, 202 and default return codes. They also must not have other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L266 |
|
Properties of a PATCH request body must not be required, property:name. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L290 |
|
The async patch operation should return 202. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L295 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L311 |
|
$skipToken is a query parameter. Post operation must not contain any query parameter other than api-version. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L384 |
|
Operations API path must follow the schema provided in the common types. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L503 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L668 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L679 |
|
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L710 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L719 |
|
The resource name parameter 'groupName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L776 |
|
The resource name parameter 'keyValueName' should be defined with a 'pattern' restriction. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L825 |
|
Synchronous and long-running PUT operations must have responses with 200, 201 and default return codes. They also must not have other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L873 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L929 |
|
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L960 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L969 |
|
Long-running POST operations must have responses with 202 and default return codes. They must also have a 200 return code if only if the final response is intended to have a schema, if not the 200 return code must not be specified. They also must not have other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1063 |
|
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1088 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1097 |
|
A tracked resource MUST always have tags as a top level optional property. Tracked resource does not have tags in the request schema. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1260 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1312 |
|
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1326 |
|
A 202 response should include an Location response header. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1359 |
|
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L1372 |
|
The parameter 'SubscriptionIdParameter' 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: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L2867 |
|
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: Microsoft.AppConfiguration/preview/2024-05-01-preview/appconfiguration.json#L2893 |
️️✔️[ignore this check status; not blocking PR merge] Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️[ignore this check status; not blocking PR merge] SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️PR Summary succeeded [Detail] [Expand]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
This was referenced Apr 25, 2024
Closed
[AutoPR @azure/arm-appconfiguration] Praveen test doc changes
openapi-env-test/azure-sdk-for-js#2028
Draft
This was referenced Jun 4, 2024
Open
10 tasks
This was referenced Dec 3, 2024
Open
Open
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.
ARM (Control Plane) API Specification Update Pull Request
Tip
Overwhelmed by all this guidance? See the
Getting helpsection at the bottom of this PR description.Note
As of January 2024 there is no PR assignee. This is expected. See https://aka.ms/azsdk/pr-arm-review.
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
If you are in purview of Step 1 of the diagram, follow the Breaking Changes review process.
IMPORTANT! This applies even if you believe your PR was mislabeled, for any reason, including tool failure.
Click here to see the details of Step 2, ARM review
See https://aka.ms/azsdk/pr-arm-review.
Click here to see the diagram footnotes
Diagram footnotes
[1] See ARM review queue (for PR merge queues, see [2]).
[2] public repo merge queue, private repo merge queue (for ARM review queue, [1])
The ARM reviewer on-call engineer visits the merge queue twice a day, so the approximate ETA for merges is 12 - 24 hours.
Purpose of this PR
What's the purpose of this PR? Check the specific option that applies. This is mandatory!
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 ApiViewcomment 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
suppressions guide to get approval.
Getting help
Purpose of this PRandDue diligence checklist.Next Steps to Mergecomment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.and https://aka.ms/ci-fix.
queuedstate, please add a comment with contents/azp run.This should result in a new comment denoting a
PR validation pipelinehas started and the checks should be updated after few minutes.