azure-rest-api-specs icon indicating copy to clipboard operation
azure-rest-api-specs copied to clipboard
verified publisher icon Azure

Added 206 response code.

Open CarlosCampos06 opened this issue 2 years ago • 6 comments

ARM API Information (Control Plane)

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow. Azure 1st Party Service can try out the Shift Left experience to initiate API design review from ADO code repo. If you are interested, may request engineering support by filling in with the form https://aka.ms/ShiftLeftSupportForm.

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
    • [X] 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.
  • Already deployed.
  1. When do you expect to publish the swagger? Please provide date or, if the date is not yet available, the month.
  • Immediately.
  1. By default, Azure SDKs of all languages (.NET/Python/Java/JavaScript for both management-plane SDK and data-plane SDK, Go for management-plane SDK only ) MUST be refreshed with/after swagger of new version is published. If you prefer NOT to refresh any specific SDK language upon swagger updates in the current PR, please leave details with justification here.

Contribution checklist (MS Employees Only):

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

ARM API Review Checklist

Applicability: :warning:

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 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 copy the existing version into the new directory structure for first commit and then push new changes, including version updates, in separate commits. You can use OpenAPIHub to initialize the PR for adding a new version. For 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 you have any breaking changes as defined in the Breaking Change Policy, request approval from the Breaking Change Review Board.

Action: to initiate an evaluation of the breaking change, create a new intake using the template for breaking changes. Additional details on the process and office hours are on the Breaking Change Wiki.

NOTE: To update API(s) in public preview for over 1 year (refer to Retirement of Previews)

Please follow the link to find more details on PR review process.

CarlosCampos06 avatar Jan 04 '23 01:01 CarlosCampos06

Hi, @CarlosCampos06 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[bot] avatar Jan 04 '23 01:01 openapi-workflow-bot[bot]

    Swagger Validation Report

    ️❌BreakingChange: 3 Errors, 0 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    changeanalysis.json 2021-04-01-preview(37a200b) 2021-04-01-preview(main)
    Rule Message
    ❌ 1011 - AddingResponseCode The new version adds a response code '206'.
    New: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L91:11
    ❌ 1011 - AddingResponseCode The new version adds a response code '206'.
    New: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L151:11
    ❌ 1011 - AddingResponseCode The new version adds a response code '206'.
    New: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L208:11
    ️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️⚠️LintDiff: 0 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    package-2021-04-01-preview package-2021-04-01-preview(37a200b) package-2021-04-01-preview(dev-changeanalysis-Microsoft.ChangeAnalysis-2021-04-01-preview)

    The following errors/warnings exist before current PR submission:

    Rule Message
    ❌ OperationsApiResponseSchema The response schema of operations API '/providers/Microsoft.ChangeAnalysis/operations' does not match the ARM specification. Please standardize the schema.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L36
    ❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Changes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L120
    ❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'Changes' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L180
    ❌ OperationIdNounVerb Per the Noun_Verb convention for Operation Ids, the noun 'ChangeSnapshots' should not appear after the underscore. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L237
    ❌ XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L314
    ❌ XmsIdentifierValidation Missing identifier id in array item property
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L423
    ❌ UniqueXmsEnumName Must not have duplicate name of x-ms-enum extension , make sure every x-ms-enum name unique. The duplicate x-ms-enum name: changetype, path: $['ChangeType']
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L545
    :warning: PreviewVersionOverOneYear The API version:2021-04-01-preview having been in a preview state over one year , please move it to GA or retire.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L5
    :warning: PostOperationIdContainsUrlVerb OperationId should contain the verb: 'resourcechanges' in:'ResourceChanges_List'. Consider updating the operationId
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L63
    :warning: OperationIdNounConflictingModelNames OperationId has a noun that conflicts with one of the model names in definitions section. The model name will be disambiguated to 'ChangeSnapshotsModel'. Consider using the plural form of 'ChangeSnapshots' to avoid this. Note: If you have already shipped an SDK on top of this spec, fixing this warning may introduce a breaking change.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L237
    :warning: SchemaDescriptionOrTitle Schema should have a description or title.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L340
    :warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L394
    :warning: AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L441
    :warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L475
    :warning: AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L490
    :warning: EnumInsteadOfBoolean Booleans properties are not descriptive in all cases and can make them to use, evaluate whether is makes sense to keep the property as boolean or turn it into an enum.
    Location: Microsoft.ChangeAnalysis/preview/2021-04-01-preview/changeanalysis.json#L619
    ️️✔️Avocado succeeded [Detail] [Expand] 
    Validation passes for Avocado.
    ️️✔️ModelValidation succeeded [Detail] [Expand] 
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand] 
    Validation passes for SemanticValidation.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️CadlValidation succeeded [Detail] [Expand] 
    Validation passes for CadlValidation.
    ️️✔️PR Summary succeeded [Detail] [Expand] 
    Validation passes for Summary.
    Posted by Swagger Pipeline | How to fix these errors?

    openapi-pipeline-app[bot] avatar Jan 04 '23 01:01 openapi-pipeline-app[bot]

    Swagger Generation Artifacts

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

    Breaking Changes Tracking



    ⚠️azure-sdk-for-js - @azure/arm-changeanalysis - 3.0.0
    +	Interface ChangesListChangesByResourceGroupNextOptionalParams no longer has parameter skipToken
+	Interface ChangesListChangesBySubscriptionNextOptionalParams no longer has parameter skipToken
+	Interface OperationsListNextOptionalParams no longer has parameter skipToken
+	Interface ResourceChangesListNextOptionalParams no longer has parameter skipToken
    ️⚠️ azure-sdk-for-python-track2 warning [Detail]
    • ⚠️Warning [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. 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
cmderr	[automation_generate.sh]
cmderr	[automation_generate.sh] npm notice New major version of npm available! 8.19.2 -> 9.2.0
cmderr	[automation_generate.sh] npm notice Changelog: <https://github.com/npm/cli/releases/tag/v9.2.0>
cmderr	[automation_generate.sh] npm notice Run `npm install -g [email protected]` to update!
cmderr	[automation_generate.sh] npm notice
    • ️✔️track2_azure-mgmt-changeanalysis [View full logs]  [Preview SDK Changes] 
      info	[Changelog]
    ️⚠️ azure-sdk-for-java warning [Detail]
    • ⚠️Warning [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. SDK Automation 14.0.0 
      command	./eng/mgmt/automation/init.sh ../azure-sdk-for-java_tmp/initInput.json ../azure-sdk-for-java_tmp/initOutput.json
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
cmderr	[init.sh] [notice] A new release of pip available: 22.3 -> 22.3.1
cmderr	[init.sh] [notice] To update, run: pip install --upgrade pip
command	./eng/mgmt/automation/generate.py ../azure-sdk-for-java_tmp/generateInput.json ../azure-sdk-for-java_tmp/generateOutput.json
    • ️✔️azure-resourcemanager-changeanalysis [View full logs]  [Preview SDK Changes]
    ️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. SDK Automation 14.0.0 
      command	sh ./eng/scripts/automation_init.sh ../../../../../azure-sdk-for-go_tmp/initInput.json ../../../../../azure-sdk-for-go_tmp/initOutput.json
command	generator automation-v2 ../../../../../azure-sdk-for-go_tmp/generateInput.json ../../../../../azure-sdk-for-go_tmp/generateOutput.json
    • ️✔️sdk/resourcemanager/changeanalysis/armchangeanalysis [View full logs]  [Preview SDK Changes] 
      info	[Changelog] ### Other Changes
info	[Changelog]
info	[Changelog] Total 0 breaking change(s), 0 additive change(s).
    ️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. SDK Automation 14.0.0 
      command	sh .scripts/automation_init.sh ../azure-sdk-for-js_tmp/initInput.json ../azure-sdk-for-js_tmp/initOutput.json
warn	File azure-sdk-for-js_tmp/initOutput.json not found to read
command	sh .scripts/automation_generate.sh ../azure-sdk-for-js_tmp/generateInput.json ../azure-sdk-for-js_tmp/generateOutput.json
    • ️✔️@azure/arm-changeanalysis [View full logs]  [Preview SDK Changes] Breaking Change Detected
      info	[Changelog] **Breaking Changes**
info	[Changelog]
info	[Changelog]   - Interface ChangesListChangesByResourceGroupNextOptionalParams no longer has parameter skipToken
info	[Changelog]   - Interface ChangesListChangesBySubscriptionNextOptionalParams no longer has parameter skipToken
info	[Changelog]   - Interface OperationsListNextOptionalParams no longer has parameter skipToken
info	[Changelog]   - Interface ResourceChangesListNextOptionalParams no longer has parameter skipToken
    ️⚠️ azure-resource-manager-schemas warning [Detail]
    • ⚠️Warning [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. 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
    • ️✔️changeanalysis [View full logs] 
    ️️✔️ azure-powershell succeeded [Detail] [Expand]
    • ️✔️Succeeded [Logs] Generate from 746ece71a1a22db9dd3296fd81abc36e1a1dd3dc. SDK Automation 14.0.0 
      command	sh ./tools/SwaggerCI/init.sh ../azure-powershell_tmp/initInput.json ../azure-powershell_tmp/initOutput.json
command	pwsh ./tools/SwaggerCI/psci.ps1 ../azure-powershell_tmp/generateInput.json ../azure-powershell_tmp/generateOutput.json
    • ️✔️Az.ChangeAnalysis [View full logs]  [Preview SDK Changes]
    Posted by Swagger Pipeline | How to fix these errors?

    openapi-pipeline-app[bot] avatar Jan 04 '23 01:01 openapi-pipeline-app[bot]

    Generated ApiView

    Language Package Name ApiView Link
    Go sdk/resourcemanager/changeanalysis/armchangeanalysis https://apiview.dev/Assemblies/Review/eecc145f8b3b4dc58e6fed293e11bd26
    Java azure-resourcemanager-changeanalysis https://apiview.dev/Assemblies/Review/ff6912f000ec4d1aa82fc57db93d6092
    JavaScript @azure/arm-changeanalysis https://apiview.dev/Assemblies/Review/57b5baac62ca413f92b459e3be89f79f

    openapi-pipeline-app[bot] avatar Jan 04 '23 01:01 openapi-pipeline-app[bot]

    Hi @CarlosCampos06, 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-workflow-bot[bot] avatar Jan 04 '23 02:01 openapi-workflow-bot[bot]

    Hi @CarlosCampos06, 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. Note: To avoid breaking change, you can refer to Shift Left Solution for detecting breaking change in early phase at your service code repository.

    openapi-workflow-bot[bot] avatar Jan 04 '23 02:01 openapi-workflow-bot[bot]

    Hi, @CarlosCampos06. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    ghost avatar Jan 22 '23 16:01 ghost

    Hi, @CarlosCampos06. The PR will be closed since the PR has no update for 28 days. If you still need the PR review to proceed, please reopen it and @ mention PR assignee.

    ghost avatar Feb 06 '23 05:02 ghost