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.

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

{azure-rest-api-specs} | update description of $top parameter #19063

Merged
merged 1 commit into from
May 16, 2022

Conversation

RakeshMohanMSFT
Copy link
Contributor

Fixes #18525

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:

  1. What's the purpose of the update?
    • new service onboarding
    • new API version
    • update existing version for new feature
    • update existing version to fix swagger quality issue in s360
    • Other, please clarify
  2. When are you targeting to deploy the new service/feature to public regions? Please provide the date or, if the date is not yet available, the month.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
  4. If updating an existing version, please select the specific language SDKs and CLIs that must be refreshed after the swagger is published.
    • SDK of .NET (need service team to ensure code readiness)
    • SDK of Python
    • SDK of Java
    • SDK of Js
    • SDK of Go
    • PowerShell
    • CLI
    • Terraform
    • No refresh required for updates in this PR

Contribution checklist:

If any further question about AME onboarding or validation tools, please view the FAQ.

ARM API Review Checklist

Applicability: ⚠️

If your changes encompass only the following scenarios, you should SKIP this section, as these scenarios do not require ARM review.

  • Change to data plane APIs
  • Adding new properties
  • All removals

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.

    • Adding a new service
    • Adding new API(s)
    • Adding a new API version
      -[ ] 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.

  • Removing API(s) in a stable version
  • Removing properties in a stable version
  • Removing API version(s) in a stable version
  • Updating API in a stable or public preview version with Breaking Change Validation errors
  • Updating API(s) in public preview over 1 year (refer to Retirement of Previews)

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.

@openapi-workflow-bot
Copy link

Hi, @RakeshMohanMSFT Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 13, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.

    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    R3030 - PathResourceProviderMatchNamespace The last resource provider 'Microsoft.Management' doesn't match the namespace.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L2053
    R4011 - DeleteOperationResponses The delete operation is defined without a 200 or 204 error response implementation,please add it.'
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4465
    R4013 - IntegerTypeMustHaveFormat The integer type does not have a format, please add it.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L5778
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.Resources/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L37
    R4032 - MissingXmsErrorResponse Response code 400 is defined without a x-ms-error-response.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L292
    R4032 - MissingXmsErrorResponse Response code 400 is defined without a x-ms-error-response.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L597
    R4032 - MissingXmsErrorResponse Response code 400 is defined without a x-ms-error-response.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L976
    R4032 - MissingXmsErrorResponse Response code 400 is defined without a x-ms-error-response.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L1364
    R4032 - MissingXmsErrorResponse Response code 400 is defined without a x-ms-error-response.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L1821
    R4037 - MissingTypeObject The schema 'DeploymentExtendedFilter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4480
    R4037 - MissingTypeObject The schema 'GenericResourceFilter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4489
    R4037 - MissingTypeObject The schema 'ResourceGroupFilter' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4506
    R4037 - MissingTypeObject The schema 'TemplateLink' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4519
    R4037 - MissingTypeObject The schema 'ParametersLink' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4544
    R4037 - MissingTypeObject The schema 'DeploymentProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4560
    R4037 - MissingTypeObject The schema 'DebugSetting' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4608
    R4037 - MissingTypeObject The schema 'Deployment' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4617
    R4037 - MissingTypeObject The schema 'ScopedDeployment' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4640
    R4037 - MissingTypeObject The schema 'DeploymentExportResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4664
    R4037 - MissingTypeObject The schema 'DeploymentWhatIf' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4673
    R4037 - MissingTypeObject The schema 'ScopedDeploymentWhatIf' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4689
    R4037 - MissingTypeObject The schema 'DeploymentWhatIfProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4706
    R4037 - MissingTypeObject The schema 'DeploymentWhatIfSettings' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4720
    R4037 - MissingTypeObject The schema 'CloudError' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4737
    R4037 - MissingTypeObject The schema 'ApiProfile' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4746
    R4037 - MissingTypeObject The schema 'AliasPathMetadata' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4760
    R4037 - MissingTypeObject The schema 'AliasPath' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4840
    R4037 - MissingTypeObject The schema 'AliasPattern' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4865
    R4037 - MissingTypeObject The schema 'Alias' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4900
    R4037 - MissingTypeObject The schema 'ProviderExtendedLocation' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Resources/stable/2021-04-01/resources.json#L4957
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️❌ModelValidation: 75 Errors, 0 Warnings failed [Detail]

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Operations_List.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L38:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L69:17
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L103:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L189:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L223:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L255:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L308:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L342:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L392:17
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L423:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L503:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L534:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L563:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L675:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtTenantScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L706:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L753:17
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L787:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L873:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L907:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L939:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1057:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtManagementGroupScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1091:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_DeleteAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1141:17
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CheckExistenceAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1175:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_GetAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1261:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_CancelAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1295:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ValidateAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1327:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ExportTemplateAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1445:15
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_ListAtSubscriptionScope.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1479:14
    XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Deployments_Delete.
    Url: Microsoft.Resources/stable/2021-04-01/resources.json#L1529:17
    ️️✔️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

    ️️✔️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).
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented May 13, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️❌SDK Breaking Change Tracking failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-sdk-for-net-track2 failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-python-track2 warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-java warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-sdk-for-go-track2 succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    ️⚠️ azure-sdk-for-js warning [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️❌ azure-resource-manager-schemas failed [Detail]

    Only 0 items are rendered, please refer to log for more details.

    ️️✔️ azure-powershell succeeded [Detail] [Expand]

    Only 0 items are rendered, please refer to log for more details.

    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @RakeshMohanMSFT, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff. If you have any questions, please post your questions in this channel https://aka.ms/swaggersupport.

    TaskHow to fixPriority
    AvocadoFix-AvocadoHigh
    Semantic validationFix-SemanticValidation-ErrorHigh
    Model validationFix-ModelValidation-ErrorHigh
    LintDiffFix-LintDiffhigh
    If you need further help, please feedback via swagger feedback.

    This was referenced May 13, 2022
    This was referenced May 16, 2022
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request May 16, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    [resources] inaccurate description for query parameters $top
    3 participants