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.

Sign up for GitHub

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

Jump to bottom

Updated AfdEndpoint and CheckNameAvailability API with additional pro… #17518

Merged
merged 18 commits into from
Feb 9, 2022
Merged

Updated AfdEndpoint and CheckNameAvailability API with additional pro… #17518

merged 18 commits into from
Feb 9, 2022

Conversation

zhuofudeng
Copy link
Member

@zhuofudeng zhuofudeng commented Jan 26, 2022 •
edited
Loading

…perty AutoGeneratedDomainNameLabelScope

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.
    Early February.
  3. When do you expect to publish the swagger? Please provide date or, the the date is not yet available, the month.
    Early February.
  4. If updating an existing version, please select the specific langauge 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 apply to the PR so that label "WaitForARMFeedback" will be added automatically to begin ARM API Review. Failure to comply may result in delays to the manifest.

    • 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.

@zhuofudeng
Updated AfdEndpoint and CheckNameAvailability API with additional pro…
2c4b73e 
…perty AutoGeneratedDomainNameLabelScope

Update afdx.json
@openapi-workflow-bot
Copy link

Hi, @skysbjdy 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. vsswagger@microsoft.com

    @openapi-workflow-bot
    Copy link

    [Call for Action] To better understand Azure service dev/test scenario, and support Azure service developer better on Swagger and REST API related tests in early phase, please help to fill in with this survey https://aka.ms/SurveyForEarlyPhase. It will take 5 to 10 minutes. If you already complete survey, please neglect this comment. Thanks.

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 26, 2022 •
    edited
    Loading

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ 1038 - AddedPath The new version is adding a path that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L37:5
    ❌ 1041 - AddedPropertyInResponse The new version has a new property 'autoGeneratedDomainNameLabelScope' in response that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4438:7
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4376:7
    ❌ 1045 - AddedOptionalProperty The new version has a new optional property 'autoGeneratedDomainNameLabelScope' that was not found in the old version.
    New: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4438:7
    Old: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4376:7
    ️⚠️LintDiff: 1 Warnings warning [Detail]
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: nameAvailable
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5384


    The following errors/warnings exist before current PR submission:

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

    Rule Message
    ❌ R4017 - TopLevelResourcesListBySubscription The top-level resource 'CdnWebApplicationFirewallPolicy' does not have list by subscription operation, please add it.
    Location: Microsoft.Cdn/stable/2021-06-01/cdnwebapplicationfirewall.json#L338
    ❌ R4037 - MissingTypeObject The schema 'Certificate' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L3978
    ❌ R4037 - MissingTypeObject The schema 'CustomerCertificate' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4004
    ❌ R4037 - MissingTypeObject The schema 'AFDDomainListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4098
    ❌ R4037 - MissingTypeObject The schema 'AFDDomainProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4130
    ❌ R4037 - MissingTypeObject The schema 'AFDDomainUpdatePropertiesParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4184
    ❌ R4037 - MissingTypeObject The schema 'DomainValidationProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4209
    ❌ R4037 - MissingTypeObject The schema 'AFDDomainHttpsParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4224
    ❌ R4037 - MissingTypeObject The schema 'SecurityPolicyListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4382
    ❌ R4037 - MissingTypeObject The schema 'AFDEndpointProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4428
    ❌ R4037 - MissingTypeObject The schema 'AFDEndpointListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4450
    ❌ R4037 - MissingTypeObject The schema 'AFDEndpointPropertiesUpdateParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4485
    ❌ R4037 - MissingTypeObject The schema 'SecretListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4536
    ❌ R4037 - MissingTypeObject The schema 'SecretProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4568
    ❌ R4037 - MissingTypeObject The schema 'RuleSetListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4731
    ❌ R4037 - MissingTypeObject The schema 'AFDOriginUpdatePropertiesParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4819
    ❌ R4037 - MissingTypeObject The schema 'SharedPrivateLinkResourceProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4897
    ❌ R4037 - MissingTypeObject The schema 'AFDOriginListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4934
    ❌ R4037 - MissingTypeObject The schema 'AFDOriginGroupUpdatePropertiesParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L4989
    ❌ R4037 - MissingTypeObject The schema 'AFDOriginGroupListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5053
    ❌ R4037 - MissingTypeObject The schema 'RouteListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5070
    ❌ R4037 - MissingTypeObject The schema 'RouteUpdatePropertiesParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5126
    ❌ R4037 - MissingTypeObject The schema 'RuleListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5259
    ❌ R4037 - MissingTypeObject The schema 'RuleUpdatePropertiesParameters' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5317
    ❌ R4037 - MissingTypeObject The schema 'AfdErrorResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5465
    ❌ R4037 - MissingTypeObject The schema 'MetricsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5475
    ❌ R4037 - MissingTypeObject The schema 'RankingsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5545
    ❌ R4037 - MissingTypeObject The schema 'ContinentsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5598
    ❌ R4037 - MissingTypeObject The schema 'ResourcesResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5628
    ❌ R4037 - MissingTypeObject The schema 'WafMetricsResponse' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.Cdn/stable/2021-06-01/afdx.json#L5690
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️~[Staging] 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.
    ️️✔️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 Jan 26, 2022 •
    edited
    Loading

    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-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-net failed [Detail]

    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 warning [Detail]

    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 @skysbjdy, 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.

    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 26, 2022
    Draft
    @openapi-workflow-bot
    Copy link

    NewApiVersionRequired reason:

    A service’s API is a contract with customers and is represented by using the api-version query parameter. Changes such as adding an optional property to a request/response or introducing a new operation is a change to the service’s contract and therefore requires a new api-version value. This is critically important for documentation, client libraries, and customer support.

    EXAMPLE: if a customer calls a service in the public cloud using api-version=2020-07-27, the new property or operation may exist but if they call the service in a government cloud, air-gapped cloud, or Azure Stack Hub cloud using the same api-version, the property or operation may not exist. Because there is no clear relationship between the service api-version and the new property/operation, customers can’t trust the documentation and Azure customer have difficulty helping customers diagnose issues. In addition, each client library version documents the service version it supports. When an optional property or new operation is added to a service and its Swagger, new client libraries must be produced to expose this functionality to customers. Without updating the api-version, it is unclear to customers which version of a client library supports these new features.

    This was referenced Jan 27, 2022
    Closed
    Closed
    Closed
    Closed
    @openapi-sdkautomation openapi-sdkautomation bot mentioned this pull request Jan 27, 2022
    Closed
    @openapi-workflow-bot
    Copy link

    Hi, @zhuofudeng your PR are labelled with WaitForARMFeedback. A notification email will be sent out shortly afterwards to notify ARM review board(armapireview@microsoft.com).

    @openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Feb 2, 2022
    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Feb 3, 2022
    @pilor pilor added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 7, 2022
    @leni-msft leni-msft merged commit 8335971 into Azure:main Feb 9, 2022
    This was referenced Feb 9, 2022
    Merged
    Closed
    Closed
    Closed
    Closed
    Closed
    Closed
    FredericHeem pushed a commit to grucloud/azure-rest-api-specs that referenced this pull request Mar 7, 2022
    @zhuofudeng @FredericHeem
    Updated AfdEndpoint and CheckNameAvailability API with additional pro… (
    cbacb71 
    Azure#17518)

* Updated AfdEndpoint and CheckNameAvailability API with additional property AutoGeneratedDomainNameLabelScope

Update afdx.json

* Added AutoGeneratedDomainNameLabelScope property into CheckNameAvailabilityInput instead of checkHostNameAvailabilityInput

* Update cdn.json

Updated the property name and its description.

* Update d property name in examples.

* Fix the reference error and a typo

* Fix the reference error in CDN API

* test

* Updated property name to camelCase style

* Updated the property name to camel case style.

* Added new checkNameAvailability API for afdx

* Updated the parameter references in new API

* Added input and output type separate from CDN one for new checkNameAvailability API

* Updated the input and out reference path for new API

* Added AfdResourceType for new API

* Updated the definition name of input and output for new API

* Updated input name in example.

* Include the required property type in the example.

* Rename the new API to CheckEndpointNameAvailability
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Reviewers

    @jorinmejia jorinmejia jorinmejia left review comments

    @ravindp ravindp ravindp approved these changes

    @leni-msft leni-msft leni-msft approved these changes

    @t-bzhan t-bzhan Awaiting requested review from t-bzhan

    Assignees

    @leni-msft leni-msft

    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-JavaScript CI-FixRequiredOnFailure
    Projects
    None yet
    Milestone
    No milestone
    Development

    Successfully merging this pull request may close these issues.
    6 participants
    @zhuofudeng @leni-msft @ravindp @jorinmejia @pilor @JeffreyRichter