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

Update Agreements.json #15634

Merged
merged 1 commit into from
Aug 31, 2021
Merged

Update Agreements.json #15634

merged 1 commit into from
Aug 31, 2021

Conversation

DanaBen-Uri
Copy link
Contributor

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits.
  • 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, @DanaBen-Uri 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-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 Aug 12, 2021

    Swagger Validation Report

    ️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    1041 - AddedPropertyInResponse The new version has a new property 'description' in response that was not found in the old version.
    New: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L477:11
    Old: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L477:11
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    The following errors/warnings exist before current PR submission:
    Rule Message
    R4015 - NestedResourcesMustHaveListOperation The nested resource 'AgreementTerms' does not have list operation, please add it.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L384
    R4018 - OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.MarketplaceOrdering/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L134
    R4037 - MissingTypeObject The schema 'AgreementTerms' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L384
    R4037 - MissingTypeObject The schema 'AgreementProperties' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L404
    R4037 - MissingTypeObject The schema 'error' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L450
    R4037 - MissingTypeObject The schema 'display' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L475
    R4037 - MissingTypeObject The schema 'OperationListResult' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L498
    R4037 - MissingTypeObject The schema 'Resource' is considered an object but without a 'type:object', please add the missing 'type:object'.
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L515
    ⚠️ R3018 - EnumInsteadOfBoolean Booleans are not descriptive and make them hard to use. Consider using string enums with allowed set of values defined. Property: accepted
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L439
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L169
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L211
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L253
    ⚠️ R4030 - UniqueXmsExample Do not have duplicate name of x-ms-example, make sure every x-ms-example name unique. Duplicate x-ms-example: SetMarketplaceTerms
    Location: Microsoft.MarketplaceOrdering/stable/2021-01-01/Agreements.json#L295
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️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.
    ️️✔️[Staging] SDK Track2 Validation succeeded [Detail] [Expand]
    Validation passes for SDKTrack2Validation

    The following errors/warnings are introduced by current PR:

    |:speech_balloon: AutorestCore/Exception|"readme":"marketplaceordering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Installing AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0)"|
    |:speech_balloon: AutorestCore/Exception|"readme":"marketplaceordering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Installed AutoRest extension '@microsoft.azure/openapi-validator' (1.8.0->1.8.0)"|


    The following errors/warnings exist before current PR submission:

    |:speech_balloon: AutorestCore/Exception|"readme":"marketplaceordering/resource-manager/readme.md",
    "tag":"package-2021-01-01",
    "details":"> Loading AutoRest extension '@autorest/modelerfour' (4.15.456->4.15.456)"|

    ️️✔️[Staging] PrettierCheck succeeded [Detail] [Expand]
    Validation passes for PrettierCheck.
    ️️✔️[Staging] SpellCheck succeeded [Detail] [Expand]
    Validation passes for SpellCheck.
    ️️✔️[Staging] 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 Aug 12, 2021

    Swagger Generation Artifacts

    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️❌[Staging] SDK Breaking Change Tracking failed [Detail]

    Breaking Changes Tracking

    ️✔️azure-sdk-for-python-track2 - track2_azure-mgmt-marketplaceordering - 1.1.0
    azure-sdk-for-go - marketplaceordering/mgmt/2015-06-01/marketplaceordering - v56.2.0
    +	Function `MarketplaceAgreementsClient.CancelResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Function `MarketplaceAgreementsClient.Cancel` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Function `MarketplaceAgreementsClient.GetAgreementResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Function `MarketplaceAgreementsClient.GetAgreement` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Function `MarketplaceAgreementsClient.ListResponder` return value(s) have been changed from `(ListAgreementTerms, error)` to `(AgreementTermsList, error)`
    +	Function `MarketplaceAgreementsClient.List` return value(s) have been changed from `(ListAgreementTerms, error)` to `(AgreementTermsList, error)`
    +	Function `MarketplaceAgreementsClient.SignResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Function `MarketplaceAgreementsClient.Sign` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
    +	Struct `ListAgreementTerms` has been removed
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9816073. SDK Automation 14.0.0
      command	sh scripts/automation_init.sh ../azure-sdk-for-python_tmp/initInput.json ../azure-sdk-for-python_tmp/initOutput.json
      cmderr	[automation_init.sh] WARNING: Skipping azure-nspkg as it is not installed.
      command	sh scripts/automation_generate.sh ../azure-sdk-for-python_tmp/generateInput.json ../azure-sdk-for-python_tmp/generateOutput.json
    • ️✔️track2_azure-mgmt-marketplaceordering [View full logs]  [Release SDK Changes]
      info	[Changelog] **Features**
      info	[Changelog]
      info	[Changelog]   - Model OperationDisplay has a new parameter description
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9816073. SDK Automation 14.0.0
      command	sh ./initScript.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
      command	generator automation ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️marketplaceordering/mgmt/2015-06-01/marketplaceordering [View full logs]  [Release SDK Changes] Breaking Change Detected
      info	[Changelog] ### Breaking Changes
      info	[Changelog]
      info	[Changelog] - Function `MarketplaceAgreementsClient.SignResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.GetAgreement` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.Sign` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.ListResponder` return value(s) have been changed from `(ListAgreementTerms, error)` to `(AgreementTermsList, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.Cancel` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.GetAgreementResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.List` return value(s) have been changed from `(ListAgreementTerms, error)` to `(AgreementTermsList, error)`
      info	[Changelog] - Function `MarketplaceAgreementsClient.CancelResponder` return value(s) have been changed from `(AgreementTerms, error)` to `(OldAgreementTerms, error)`
      info	[Changelog] - Struct `ListAgreementTerms` has been removed
      info	[Changelog]
      info	[Changelog] ### New Content
      info	[Changelog]
      info	[Changelog] - New const `Canceled`
      info	[Changelog] - New const `Active`
      info	[Changelog] - New function `OldAgreementTerms.MarshalJSON() ([]byte, error)`
      info	[Changelog] - New function `PossibleStateValues() []State`
      info	[Changelog] - New function `*OldAgreementTerms.UnmarshalJSON([]byte) error`
      info	[Changelog] - New struct `AgreementTermsList`
      info	[Changelog] - New struct `OldAgreementProperties`
      info	[Changelog] - New struct `OldAgreementTerms`
      info	[Changelog] - New struct `UnsupportedMediaTypeErrorResponse`
      info	[Changelog] - New field `Description` in struct `OperationDisplay`
      info	[Changelog]
      info	[Changelog] Total 10 breaking change(s), 14 additive change(s).
      info	[Changelog]
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 9816073. SDK Automation 14.0.0
      warn	Skip initScript due to not configured
      command	autorest --version=V2 --typescript --license-header=MICROSOFT_MIT_NO_VERSION [email protected]/[email protected] --typescript-sdks-folder=/home/vsts/work/1/s/azure-sdk-for-js/azure-sdk-for-js ../../azure-rest-api-specs/specification/marketplaceordering/resource-manager/readme.md
    • ️✔️@azure/arm-marketplaceordering [View full logs]  [Release SDK Changes]
      cmderr	[npmPack] loaded rollup.config.js with warnings
      cmderr	[npmPack] (!) Unused external imports
      cmderr	[npmPack] default imported from external module 'rollup' but never used
      cmderr	[npmPack] ./esm/marketplaceOrderingAgreements.js → ./dist/arm-marketplaceordering.js...
      cmderr	[npmPack] created ./dist/arm-marketplaceordering.js in 206ms
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 9816073. Schema Automation 14.0.0
      command	.sdkauto/initScript.sh ../azure-resource-manager-schemas_tmp/initInput.json ../azure-resource-manager-schemas_tmp/initOutput.json
      cmderr	[initScript.sh] WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile The package-lock.json file was created with an old version of npm,
      cmderr	[initScript.sh] npm WARN old lockfile so supplemental metadata must be fetched from the registry.
      cmderr	[initScript.sh] npm WARN old lockfile
      cmderr	[initScript.sh] npm WARN old lockfile This is a one-time fix-up, please be patient...
      cmderr	[initScript.sh] npm WARN old lockfile
      warn	File azure-resource-manager-schemas_tmp/initOutput.json not found to read
      command	.sdkauto/generateScript.sh ../azure-resource-manager-schemas_tmp/generateInput.json ../azure-resource-manager-schemas_tmp/generateOutput.json
      warn	No file changes detected after generation
      warn	Skip detect changed packages
    Posted by Swagger Pipeline | How to fix these errors?

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

    @DanaBen-Uri
    Copy link
    Contributor Author

    DanaBen-Uri commented Aug 12, 2021

    Hi @weidongxu-microsoft,
    The changes I'm trying to do are in response to an S360 Alert that was triggered for the swagger.
    One of the required checks that failed is "Swagger BreakingChange". I just add a "description" field to the new version, there aren't users that used it yet.

    @weidongxu-microsoft
    Copy link
    Member

    @DanaBen-Uri

    Yours is stable version. You still need to get approval from Jeffery if you want to add it to existing version.

    @DanaBen-Uri
    Copy link
    Contributor Author

    @weidongxu-microsoft
    Can you add Jeffrey to this conversation?

    @openapi-workflow-bot
    Copy link

    Hi @DanaBen-Uri, one or multiple breaking change(s) is detected in your PR. Please check out the breaking change(s), and provide business justification in the PR comment and @ PR assignee why you must have these change(s), and how external customer impact can be mitigated. Please ensure to follow breaking change policy to request breaking change review and approval before proceeding swagger PR review.
    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.
    If you want to know the production traffic statistic, please see ARM Traffic statistic.
    If you think it is false positive breaking change, please provide the reasons in the PR comment, report to Swagger Tooling Team via https://aka.ms/swaggerfeedback.

    @weidongxu-microsoft
    Copy link
    Member

    Label added.

    @DanaBen-Uri
    Copy link
    Contributor Author

    Hey Jeffry,
    Can we get an exception to this PR?
    I just add a "description" field to the new version, there aren't users that used it yet.

    @DanaBen-Uri
    Copy link
    Contributor Author

    Hey @weidongxu-microsoft,
    How do I proceed from here?

    @weidongxu-microsoft
    Copy link
    Member

    Follow #15634 (comment)

    @JeffreyRichter JeffreyRichter added the Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 label Aug 30, 2021
    @jianyexi
    Copy link
    Contributor

    Please comment if you want to merge

    @DanaBen-Uri
    Copy link
    Contributor Author

    Please comment if you want to merge

    yes, please merge

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    Approved-BreakingChange DO NOT USE! OBSOLETE label. See https://github.com/Azure/azure-sdk-tools/issues/6374 CI-BreakingChange-Go
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    4 participants