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

Remove Registries PUT 202 Body #21978

Merged
merged 1 commit into from
Dec 22, 2022
Merged

Conversation

komo23x
Copy link
Contributor

@komo23x komo23x commented Dec 22, 2022

Choose a PR Template

Switch to "Preview" on this description then select one of the choices below.

Click here to open a PR for a Data Plane API.

Click here to open a PR for a Control Plane (ARM) API.

@openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented Dec 22, 2022

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️⚠️Breaking Change(Cross-Version): 5 Warnings warning [Detail]
compared swaggers (via Oad v0.10.2)] new version base version
registries.json 2022-12-01-preview(5d18c45) 2022-10-01-preview(main)

The following breaking changes are detected by comparison with the latest preview version:

Rule Message
⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L151:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L285:11
⚠️ 1011 - AddingResponseCode The new version adds a response code '202'.
New: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L377:11
⚠️ 1036 - ConstraintChanged The new version has a different 'pattern' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L129:11
Old: Microsoft.MachineLearningServices/preview/2022-10-01-preview/registries.json#L125:11
⚠️ 1044 - XmsLongRunningOperationChanged The new version has a different 'x-ms-longrunning-operation' value than the previous one.
New: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L109:7
Old: Microsoft.MachineLearningServices/preview/2022-10-01-preview/registries.json#L109:7
️⚠️LintDiff: 0 Warnings warning [Detail]
compared tags (via openapi-validator v2.0.0) new version base version
package-preview-2022-12 package-preview-2022-12(5d18c45) package-preview-2022-12(machinelearningservices-Microsoft.MachineLearningServices-2022-12-01-preview)

The following errors/warnings exist before current PR submission:

Rule Message
LongRunningResponseStatusCode A 'delete' operation 'Registries_Delete' with x-ms-long-running-operation extension must have a valid terminal success status code 200 or 204.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L109
CreateOperationAsyncResponseValidation Only 201 is the supported response code for PUT async response.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L377
LroLocationHeader A 202 response should include an Location response header.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L377
ArmResourcePropertiesBag Top level property names should not be repeated inside the properties bag for ARM resource 'RegistryTrackedResource'. Properties [properties.tags] conflict with ARM top level properties. Please rename these.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L583
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L22
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L67
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L122
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L191
⚠️ LroExtension Operations with a 202 response should specify x-ms-long-running-operation: true.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L232
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L244
⚠️ ParameterNotDefinedInGlobalParameters Parameter 'api-version' is referenced but not defined in the global parameters section of Service Definition
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L330
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L437
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L474
⚠️ LocationMustHaveXmsMutability Property location must have 'x-ms-mutability':['read', 'create'] extension defined.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L566
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L583
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L602
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L632
⚠️ AvoidNestedProperties Consider using x-ms-client-flatten to provide a better end user experience
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L640
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L799
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L814
⚠️ 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.MachineLearningServices/preview/2022-12-01-preview/registries.json#L822
⚠️ 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.MachineLearningServices/preview/2022-12-01-preview/registries.json#L830
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L836
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L847
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
Rule Message
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 202 for operation Registries_CreateOrUpdate has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L358:22
ExampleUrl: 2022-12-01-preview/examples/Registries/createOrUpdate-SystemCreated.json#L62:16
RESPONSE_SCHEMA_NOT_IN_SPEC Response statusCode 202 for operation Registries_CreateOrUpdate has response body provided in the example, however the response does not have a "schema" defined in the swagger spec.
Url: Microsoft.MachineLearningServices/preview/2022-12-01-preview/registries.json#L358:22
ExampleUrl: 2022-12-01-preview/examples/Registries/createOrUpdate-UserCreated.json#L58:16
️️✔️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 pending [Detail]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-workflow-bot
Copy link

Hi, @komo23x 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. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Dec 22, 2022

    Swagger Generation Artifacts

    ️❌ApiDocPreview: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    RestBuild error "logUrl":"https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=338297&view=logs&j=fd490c07-0b22-5182-fac9-6d67fe1e939b",
    "detail":"Run.ps1 failed with exit code 128 "
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️🔄 azure-sdk-for-net-track2 inProgress [Detail]
    ️🔄 azure-sdk-for-go inProgress [Detail]
    ️🔄 azure-sdk-for-python-track2 inProgress [Detail]
    ️🔄 azure-sdk-for-java inProgress [Detail]
    ️🔄 azure-sdk-for-js inProgress [Detail]
    ️🔄 azure-resource-manager-schemas inProgress [Detail]
    ️🔄 azure-powershell inProgress [Detail]
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    Swagger pipeline started successfully. If there is ApiView generated, it will be updated in this comment.

    @ivaliyivanov ivaliyivanov merged commit 43a9ffb into Azure:machinelearningservices-Microsoft.MachineLearningServices-2022-12-01-preview Dec 22, 2022
    ArcturusZhang pushed a commit that referenced this pull request Feb 1, 2023
    …1 preview (#21761)
    
    * Adds base for updating Microsoft.MachineLearningServices from version preview/2022-10-01-preview to version 2022-12-01-preview
    
    * Updates readme
    
    * Updates API version in new specs and examples
    
    * Add Dec API Registries Swagger (#21419)
    
    * add december registries swagger + examples
    
    * add status code 202 in examples
    
    * fix 202 examples
    
    * fixes
    
    * fixes
    
    * fix
    
    * add 202 back in for put/patch
    
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    
    * remove location (#21430)
    
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    
    * remove readonly flag on schedules property for CI (#21653)
    
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    
    * add missing workspace properties (#21725)
    
    * December preview updating mfe.json specs (#21510)
    
    * December preview updating mfe.json specs
    
    * MFE Dec 2022 Preview API - Adding logbase
    
    * MFE 2022-12-01-preview swagger spec model validation fix
    
    * MFE 2022-12-01-preview swagger spec model validation fix, add missing location
    
    * MFE 2022-12-01-preview swagger spec model validation - typo fix
    
    * MFE 2022-12-01-preview swagger spec model validation - fix api version in automljob example
    
    * MFE 2022-12-01-preview swagger spec model validation - fix for multiselectenabled error
    
    * MFE 2022-12-01-preview swagger spec model validation - fix for multiselectenabled error
    
    * Fix  for 1006 - RemovedDefinition (RecurrenceTrigger,CronTrigger) (#21822)
    
    * fix ReadonlyPropertyChanged of MLC (#21814)
    
    Co-authored-by: Bingchen Li <bingchenli@microsoft.com>
    
    * fixed custom-words conflict (#21829)
    
    * fix custom-words conflict merge (#21830)
    
    * example fix (INVALID_REQUEST_PARAMETER) (#21832)
    
    Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local>
    
    * example fix, use correct api preview version  - (INVALID_REQUEST_PARAMETER) (#21833)
    
    Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local>
    
    * Revert breaking change for MLC swagger 2022-12-01-preview (#21885)
    
    Co-authored-by: Bingchen Li <bingchenli@microsoft.com>
    
    * Revert Connection Category back to enum. (#21939)
    
    * revert provisioning state change (#21940)
    
    * remove body (#21978)
    
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    
    * Addressed comments, added x-ms-long-running-operation to a patch call (#22005)
    
    * Addressed comments, added x-ms-long-running-operation to a patch call
    
    * fix examples for patch - remove body
    
    * fixed formatting
    
    * Ivalbert fix patch2 (#22006)
    
    * Addressed comments, added x-ms-long-running-operation to a patch call
    
    * fix examples for patch - remove body
    
    * fixed formatting
    
    * fixed formatting
    
    * Updated custom words (#22262)
    
    * Fixed prettier errors (#22237)
    
    * fixed examples for LRO_RESPONSE_HEADER check (#22293)
    
    * fixed examples for LRO_RESPONSE_HEADER check (#22294)
    
    * Example fix - OBJECT_MISSING_REQUIRED_PROPERTY - Missing required property: triggerType (#22317)
    
    ---------
    
    Co-authored-by: Komal Yadav <23komal.yadav23@gmail.com>
    Co-authored-by: Komal Yadav <komalyadav@microsoft.com>
    Co-authored-by: Naman Agarwal <namanag16@gmail.com>
    Co-authored-by: Naman Agarwal <naagarw@microsoft.com>
    Co-authored-by: ZhidaLiu <zhili@microsoft.com>
    Co-authored-by: libc16 <88697960+libc16@users.noreply.github.com>
    Co-authored-by: Bingchen Li <bingchenli@microsoft.com>
    Co-authored-by: Ivaliy Ivanov <ivaliyivanov@Ivaliys-MacBook-Air.local>
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Labels
    None yet
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    2 participants