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

OMode ModelAsString update to make it nullable and rearrangements to avoid breaking change in .Net #12963

Merged
merged 7 commits into from
Feb 17, 2021

Conversation

Sandido
Copy link
Member

@Sandido Sandido commented Feb 11, 2021

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Changelog

Please ensure to add changelog with 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 you are targeting to deploy new service/feature to public regions? Please provide date, or month to public if date is not available yet.
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.
  4. If it's an update to existing version, please select SDKs of specific language and CLIs that require refresh after 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, no need to refresh 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

  • Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review.

    • Adding new API(s)
    • Adding a new API version
    • Adding a new service
  • Please 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 there are following updates in the PR, ensure to request an approval from Breaking Change Review Board as defined in the Breaking Change Policy.

  • Removing API(s) in stable version
  • Removing properties in stable version
  • Removing API version(s) in stable version
  • Updating API in 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, @Sandido 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. [email protected]

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 11, 2021

    Swagger Validation Report

    ️⌛BreakingChange pending [Detail]
    ️⌛LintDiff pending [Detail]
    ️⌛Avocado pending [Detail]
    ️⌛ModelValidation pending [Detail]
    ️⌛SemanticValidation pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on preview version) pending [Detail]
    ️⌛[Staging] Cross Version BreakingChange (Base on stable version) pending [Detail]
    ️⌛CredScan pending [Detail]
    ️❌[Staging] SDK Track2 Validation: 2 Errors, 558 Warnings failed [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    PreCheck/DuplicateSchema "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"Duplicate Schema named PurchasePlan -- properties.promotionCode: undefined => "description":"The Offer Promotion Code.",
    "$ref":"#/components/schemas/schemas:1246" ; This error can be temporarily avoided by using the 'modelerfour.lenient-model-deduplication' setting. NOTE: This setting will be removed in a future version of @autorest/modelerfour; schemas should be updated to fix this issue sooner than that."
    AutorestCore/Exception "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"Error: Plugin prechecker reported failure."
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'ComputeOperationListResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'ComputeOperationValue' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'ComputeOperationValueDisplay' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'DisallowedConfiguration' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'RetrieveBootDiagnosticsDataResult' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'InstanceViewStatus' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'AvailabilitySetProperties' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ⚠️ PreCheck/SchemaMissingType "readme":"compute/resource-manager/readme.md",
    "tag":"package-2020-12-01",
    "details":"The schema 'AvailabilitySet' with an undefined type and decalared properties is a bit ambigious. This has been auto-corrected to 'type:object'"
    ️⌛[Staging] PrettierCheck pending [Detail]
    ️⌛[Staging] SpellCheck pending [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Feb 11, 2021

    Swagger Generation Artifacts

    ️🔄 azure-sdk-for-net inProgress [Detail]
    ️🔄[Staging] ApiDocPreview inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @Sandido Sandido changed the title OMode ModelAsString update to make it nullable OMode ModelAsString update to make it nullable and rearrangements to avoid breaking change in .Net Feb 11, 2021
    @Sandido
    Copy link
    Member Author

    Sandido commented Feb 11, 2021

    /azp run

    @azure-pipelines
    Copy link

    Azure Pipelines successfully started running 2 pipeline(s).

    @Sandido Sandido requested a review from ajjha-az February 11, 2021 23:19
    trying to arrange for the one ForceDelete breaking change.
    @openapi-workflow-bot
    Copy link

    Hi @Sandido, Your PR has some issues. Please fix the CI sequentially by following the order of Avocado, semantic validation, model validation, breaking change, lintDiff.

    TaskHow to fixPrioritySupport (Microsoft alias)
    AvocadoFix-AvocadoHighruowan
    Semantic validationFix-SemanticValidation-ErrorHighraychen, jianyxi
    Model validationFix-ModelValidation-ErrorHighraychen,jianyxi
    LintDiffFix-LintDiffhighjianyxi, ruoxuan
    If you need further help, please feedback via swagger feedback."

    @Sandido Sandido requested a review from allenjzhang February 16, 2021 20:36
    @allenjzhang allenjzhang merged commit 202d83c into master Feb 17, 2021
    This was referenced Feb 17, 2021
    mkarmark pushed a commit to mkarmark/azure-rest-api-specs that referenced this pull request Jul 21, 2021
    …avoid breaking change in .Net (Azure#12963)
    
    * Update compute.json
    
    * Update compute.json
    
    * Update compute.json
    
    * Update compute.json
    
    * Update compute.json
    
    trying to arrange for the one ForceDelete breaking change.
    
    * Update compute.json
    
    * Update compute.json
    @JackTn JackTn deleted the SandidoOModeModel branch August 17, 2021 06:05
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-OkToMerge <valid label in PR review process>add this label when assignee approve to merge the updates CI-BreakingChange-Go Compute
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants