-
Notifications
You must be signed in to change notification settings - Fork 5.6k
Auto export specification 2024-07-01 #28910
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
Auto export specification 2024-07-01 #28910
Conversation
Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec.
Updated the API version from stable/2024-03-01 to stable/2024-07-01.
Next Steps to Merge✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge. |
Swagger Validation Report
|
| Compared specs (v0.10.12) | new version | base version |
|---|---|---|
| amlfilesystem.json | 2024-07-01(882059f) | 2024-03-01(main) |
| amlfilesystem.json | 2024-07-01(882059f) | 2023-11-01-preview(main) |
| storagecache.json | 2024-07-01(882059f) | 2024-03-01(main) |
| storagecache.json | 2024-07-01(882059f) | 2023-11-01-preview(main) |
The following breaking changes are detected by comparison with the latest stable version:
The following breaking changes are detected by comparison with the latest preview version:
| Rule | Message |
|---|---|
| The '$ref' property points to different models in the old and new versions. New: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L2006:9 Old: Microsoft.StorageCache/preview/2023-11-01-preview/storagecache.json#L2006:9 |
|
| The new version is adding a path that was not found in the old version. New: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L465:5 |
|
| The new version is adding a path that was not found in the old version. New: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L722:5 |
|
| The new version is adding a path that was not found in the old version. New: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L770:5 |
|
| The new version is adding a path that was not found in the old version. New: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L1027:5 |
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 1 Warnings warning [Detail]
| Compared specs (v2.2.2) | new version | base version |
|---|---|---|
| package-2024-07 | package-2024-07(882059f) | default(main) |
[must fix]The following errors/warnings are introduced by current PR:
| Rule | Message | Related RPC [For API reviewers] |
|---|---|---|
| Use the latest version v5 of types.json. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L1684 |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L126 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L167 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L281 |
PatchIdentityProperty |
The patch operation body parameter schema should contain property 'identity'. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L320 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:keyUrl. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L325 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:sourceVault. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L325 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L353 |
PostResponseCodes |
Synchronous POST operations must have one of the following combinations of responses - 200 and default ; 204 and default. They also must not have other response codes. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L1076 |
NoErrorCodeResponses |
Invalid status code specified. Please refer to the documentation for the allowed set. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L1100 |
AvoidAdditionalProperties |
Definitions must not have properties named additionalProperties except for user defined tags or predefined references. Location: Microsoft.StorageCache/stable/2024-07-01/amlfilesystem.json#L2196 |
OperationsApiSchemaUsesCommonTypes |
Operations API path must follow the schema provided in the common types. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L52 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L297 |
SubscriptionsAndResourceGroupCasing |
The path segment resourcegroups should be resourceGroups. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L342 |
DeleteResponseCodes |
Long-running delete operations must have responses with 202, 204 and default return codes. They also must have no other response codes. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L343 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L384 |
PutResponseCodes |
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.StorageCache/stable/2024-07-01/storagecache.json#L443 |
LroLocationHeader |
A 202 response should include an Location response header. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L486 |
LroErrorContent |
Error response content of long running operations must follow the error schema provided in the common types v2 and above. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L492 |
UnSupportedPatchProperties |
Mark the top-level property 'id', 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. This property is not patchable. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L531 |
UnSupportedPatchProperties |
Mark the top-level property 'name', 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. This property is not patchable. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L531 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:mtu. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:ntpServer. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:keyUrl. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:sourceVault. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:primaryDnsIpAddress. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:domainName. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:domainNetBiosName. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:cacheNetBiosName. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not be required, property:username. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
PatchBodyParametersSchema |
Properties of a PATCH request body must not have default value, property:usernameSource. Location: Microsoft.StorageCache/stable/2024-07-01/storagecache.json#L535 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView 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.
️️✔️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
|
49c5bed to
5c23139
Compare
…export-spec into Aman-Jain-14/auto-export-spec-24-07-01
92be441 to
2df3c09
Compare
|
API change check APIView has identified API level changes in this PR and created following API reviews. |
c698b58 to
2df3c09
Compare
* Copy files from stable/2024-03-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-07-01 Updated the API version from stable/2024-03-01 to stable/2024-07-01. * Added tag for 2024-07-01 in readme file * Adding 2024-07-01 stable specification for auto export feature * Addressing lint errors * Fixing spell check error * Fixing prettier errors * Addressing prettier errors * Amending incorrect AutoExport tags * Fixing prettier checks errors --------- Co-authored-by: Aman Jain <[email protected]>
* Copy files from stable/2024-03-01 Copied the files in a separate commit. This allows reviewers to easily diff subsequent changes against the previous spec. * Update version to stable/2024-07-01 Updated the API version from stable/2024-03-01 to stable/2024-07-01. * Added tag for 2024-07-01 in readme file * Adding 2024-07-01 stable specification for auto export feature * Addressing lint errors * Fixing spell check error * Fixing prettier errors * Addressing prettier errors * Amending incorrect AutoExport tags * Fixing prettier checks errors --------- Co-authored-by: Aman Jain <[email protected]>
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.