Skip to content

Conversation

@MiriBerezin
Copy link
Contributor

@MiriBerezin MiriBerezin commented Jan 19, 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 API version for new APIs
  2. When you are targeting to deploy new service/feature to public regions? 24/1/2021
  3. When you expect to publish swagger? Please provide date, or month to public if date is not available yet.

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
  • 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 API 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 version with Breaking Change Validation errors
  • Updating API(s) in preview over 1 year

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, @MiriBerezin 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 Jan 19, 2021

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️LintDiff: 34 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ R1003 - ListInOperationName Since operation 'PrivateStore_GetApprovalRequestsList' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113
    ⚠️ R1003 - ListInOperationName Since operation 'PrivateStore_AdminRequestApprovalsList' response has model definition 'array', it should be of the form '_list'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316
    ⚠️ R1005 - GetInOperationName 'GET' operation 'PrivateStore_AdminRequestApprovalsList' 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.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L316
    ⚠️ R1006 - PutInOperationName 'PUT' operation 'PrivateStore_UpdateAdminRequestApproval' should use method name 'Create'. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L386
    ⚠️ R2001 - AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L937
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateStore_GetApprovalRequestsList' might be pageable. Consider adding the x-ms-pageable extension.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L109
    ⚠️ R2029 - PageableOperation Based on the response model schema, operation 'PrivateStore_AdminRequestApprovalsList' might be pageable. Consider adding the x-ms-pageable extension.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L312
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L32
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L71
    ⚠️ R2063 - OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'PrivateStoreModel'. Consider using the plural form of 'PrivateStore' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L113
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️[Staging] Cross Version BreakingChange (Base on preview version) succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️[Staging] Cross Version BreakingChange (Base on stable version): 14 Warnings warning [Detail] Only 10 items are listed, please refer to log for more details.

    Rule Message
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L19:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L61:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L106:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/subscriptions/{subscriptionId}/providers/Microsoft.Marketplace/privateStores/{privateStoreId}/offers/{offerId}' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L247:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L333:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/privateStores/{privateStoreId}' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L375:5
    ⚠️ 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/providers/Microsoft.Marketplace/operations' removed or restructured?
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L478:5
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PrivateStoreOperation' removed or renamed?
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PrivateStore' removed or renamed?
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'PrivateStoreProperties' removed or renamed?
    New: Microsoft.Marketplace/stable/2020-12-01/Marketplace.json#L468:3
    Old: Microsoft.Marketplace/stable/2020-01-01/Marketplace.json#L548:3
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Jan 19, 2021

    Swagger Generation Artifacts

    ️️✔️ azure-resource-manager-schemas succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs]Release - Generate from 8d7208b. Schema Automation 14.0.0
      warn	Skip initScript due to not configured
      command	npx n 12
      command	autorest --use=@autorest/[email protected] --version=3.0.6369 --azureresourceschema --multiapi --title=none --pass-thru:subset-reducer --azureresourceschema-folder=/home/vsts/work/1/s/azure-resource-manager-schemas/azure-resource-manager-schemas ../../azure-rest-api-specs/specification/marketplace/resource-manager/readme.md
    • ️✔️marketplace [View full logs]  [Release Schema Changes]
      cmderr	[resource-manager] node-pre-gyp
      cmderr	[resource-manager] WARN Using request for node-pre-gyp https download
      cmderr	[resource-manager] WARN [email protected] No repository field.
      cmderr	[resource-manager]  optional SKIPPING OPTIONAL DEPENDENCY: [email protected] (node_modules/fsevents):
      cmderr	[resource-manager] npm WARN notsup SKIPPING OPTIONAL DEPENDENCY: Unsupported platform for [email protected]: wanted {"os":"darwin","arch":"any"} (current: {"os":"linux","arch":"x64"})
    ️️✔️ azure-sdk-for-net succeeded [Detail] [Expand]
    ️️✔️[Staging] ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-workflow-bot
    Copy link

    Hi @MiriBerezin, 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."

    @jorgecotillo
    Copy link
    Contributor

    Are your POST and PUT operations long running operations? If yes, you need to conform to this

    @MiriBerezin
    Copy link
    Contributor Author

    @jorgearteiro no, our APIs are NOT long-running operations

    @jorgecotillo
    Copy link
    Contributor

    @jorgearteiro no, our APIs are NOT long-running operations

    Ok. There's an important checkbox that was not marked:

    [] I have reviewed the documentation for the workflow.

    We'll let it pass this time, but future PRs if the documentation was not read prior creating the PR, the PR would not be reviewed.

    @jorgecotillo jorgecotillo added ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review and removed ARMChangesRequested WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required labels Feb 1, 2021
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    10 participants