[NetAppFiles] Bugfix Add missing x-ms-pageable to new operation #19390
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
|
Hi, @audunn Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
1 similar comment
|
Hi, @audunn Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| Rule | Message |
|---|---|
|
The response schema of operations API '/providers/Microsoft.NetApp/operations' does not match the ARM specification. Please standardize the schema. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L40 |
|
The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4004 |
|
The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4027 |
|
The schema 'OperationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4059 |
|
The schema 'ServiceSpecification' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4068 |
|
The schema 'MetricSpecification' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4093 |
|
The schema 'Dimension' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4196 |
|
The schema 'exportPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L5020 |
|
The schema 'dataProtection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L5166 |
|
The schema 'exportPolicy' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L5744 |
|
The schema 'dataProtection' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L5766 |
|
The schema 'cloudError' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6813 |
|
The schema 'cloudErrorBody' is considered an object but without a 'type:object', please add the missing 'type:object'. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6823 |
| 'GET' operation 'Volumes_ReplicationStatus' should use method name 'Get' or Method name start with 'List'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L1267 |
|
| Based on the response model schema, operation 'Volumes_Get' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L866 |
|
| Based on the response model schema, operation 'SnapshotPolicies_ListVolumes' might be pageable. Consider adding the x-ms-pageable extension. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L2348 |
|
| The child tracked resource, 'capacityPools' with immediate parent 'netAppAccount', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4688 |
|
| The child tracked resource, 'volumes' with immediate parent 'capacityPool', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4912 |
|
| The child tracked resource, 'snapshots' with immediate parent 'volume', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L5905 |
|
| The child tracked resource, 'snapshotPolicies' with immediate parent 'netAppAccount', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6013 |
|
| The child tracked resource, 'accountBackups' with immediate parent 'netAppAccount', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6308 |
|
| The child tracked resource, 'backups' with immediate parent 'volume', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6308 |
|
| The child tracked resource, 'backupPolicies' with immediate parent 'netAppAccount', must have a list by immediate parent operation. Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L6495 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: forceDelete Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L1064 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: enableRegionalMdmAccount Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4138 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: fillGapWithZero Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4164 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isInternal Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4176 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: isAvailable Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4213 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: aesEncryption Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4598 |
|
| Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: ldapSigning Location: Microsoft.NetApp/stable/2022-01-01/netapp.json#L4602 |
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️Cross-Version Breaking Changes succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SDK Track2 Validation succeeded [Detail] [Expand]
Validation passes for SDKTrack2Validation
- The following tags are being changed in this PR
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
Swagger Generation Artifacts
|
audunn
changed the title
This was referenced Jun 9, 2022
akning-ms
approved these changes
Jun 10, 2022
This was referenced Jun 10, 2022
Closed
Closed
gerrytan
added a commit
to gerrytan/azure-rest-api-specs
that referenced
this pull request
Sep 6, 2024
* TypeSpec for Microsoft.AzureTerraform * Sorted swagger file, and added typespec generated with tsp-client * revert export.json in prep of merging * Sorted export.json for easy diff on future typespec -> swagger * Rerun swagger -> typespec conversion after merging latest RPSaaSMaster, updated namespace * tsp compile for TypeSpec -> swagger * Refactored typescript to minimise swagger diff * Spread ErrorResponse into OperationStatus model * Fixed enums, use doc decorator * Update exportTerraform path desc * Update doc for ExportResource model * LintDiff fix: remove unnecessary auth * Add resourceId prop to OperationStatus model, fixed char casing so they're consistent throughout * Made resourceId read only * Check `Swagger BreakingChange`: minimise diff on x-ms-enum * TypeSpec Validation fix: rename dir and add missing @doc
gerrytan
added a commit
that referenced
this pull request
Sep 20, 2024
…o Terraform HCL (#30455) * New RP: Microsoft.AzureTerraform (ver=2023-07-01-preview) * prettier * remove x-ms-discriminator-value * readme.md: add `openapi-subtype` * Fix LintDiff failure * Result configuration type change from object to string * Remove properties: `subscriptionId` and `environment` * Change `errors` from list of string to list of `ErrorResponse` * Add operations endpoint * Update * Update * AzureTerraform RP: Sync the MS version with the private version * Terraform: Change `exportEerraform` endpoint to LRO (#18782) * terraform: Modify the `exportTerraform` RT to be LRO * Update * prettier * spell * CI validation * More CI issue fixes * typo * Add readme.go.md * typo * prettier * suppression * Update suppression * AzureTerrform: Remove the parallelism property (#18909) * exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults (#19178) * exportTerraform: Change resourceId -> resourceIds; Add `maskSensitive`; Change `fullConfig` defaults * rename * rename * rename * Specify LRO model (#19401) * Add up the `resourceId` in `OperationStatus` model (#19450) * Add `uri` format (#19455) * Add format url * update * TypeSpec for Microsoft.AzureTerraform (#19390) * TypeSpec for Microsoft.AzureTerraform * Sorted swagger file, and added typespec generated with tsp-client * revert export.json in prep of merging * Sorted export.json for easy diff on future typespec -> swagger * Rerun swagger -> typespec conversion after merging latest RPSaaSMaster, updated namespace * tsp compile for TypeSpec -> swagger * Refactored typescript to minimise swagger diff * Spread ErrorResponse into OperationStatus model * Fixed enums, use doc decorator * Update exportTerraform path desc * Update doc for ExportResource model * LintDiff fix: remove unnecessary auth * Add resourceId prop to OperationStatus model, fixed char casing so they're consistent throughout * Made resourceId read only * Check `Swagger BreakingChange`: minimise diff on x-ms-enum * TypeSpec Validation fix: rename dir and add missing @doc * Upgrade/rp tsp 0.60 (#19551) -- applying only for specification/terraform * Revert accidental changes to cSpell.json while merging * Added tf files used for armstrong testing --------- Co-authored-by: magodo <wztdyl@sina.com>
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.
#19225
#18516
Added api-version 2022-01-01 and where recently merged no SDK have been relased yet. We see that one operation added in this api version
Volumes_ListReplicationsis missingx-ms-pageablewe would like to add it before SDKs are generated to avoid breaking changes if pageable support is added later in the service.MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.
Changelog
Add a changelog entry for this PR by answering the following questions:
Adds missing
x-ms-pageableto an operation, no SDK have been released yetContribution checklist:
If any further question about AME onboarding or validation tools, please view the FAQ.
ARM API Review Checklist
Otherwise your PR may be subject to ARM review requirements. Complete the following:
Check this box if any of the following appy to the PR so that the label "ARMReview" and "WaitForARMFeedback" will be added by bot to kick off ARM API Review. Missing to check this box in the following scenario may result in delays to the ARM manifest review and deployment.
-[ ] To review changes efficiently, ensure you are using OpenAPIHub to initialize the PR for adding a new version. More details, refer to the wiki.
Ensure you've reviewed following guidelines including ARM resource provider contract and REST guidelines. Estimated time (4 hours). This is required before you can request review from ARM API Review board.
If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Breaking Change Review Checklist
If any of the following scenarios apply to the PR, request approval from the Breaking Change Review Board as defined in the Breaking Change Policy.
Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Addition details on the process and office hours are on the Breaking change Wiki.
Please follow the link to find more details on PR review process.