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

Published 20 hours ago • verified publisher icon Azure

[Cognitive - AzureOpenAI] Review request for GA version 2022-12-01

Open bexxx opened this issue 2 years ago • 7 comments

Data Plane API - Pull Request

Based on preview version 2022-06-01 we are planning to publish a GA version 2022-12-01. First iteration are the files of version 2022-06-01-preview to simplify diffing.

API Info: The Basics

Most of the information about your service should be captured in the issue that serves as your engagement record.

  • Link to engagement record issue:

Is this review for (select one):

  • [ ] a private preview
  • [ ] a public preview
  • [X] GA release

Change Scope

This section will help us focus on the specific parts of your API that are new or have been modified.
Please share a link to the design document for the new APIs, a link to the previous Open API document (swagger) if applicable, and the root paths that have been updated.

  • Design Document:
  • Previous Open API Doc: https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2022-06-01-preview
  • Updated paths:

❔Got questions? Need additional info?? We are here to help!

Contact us!

The Azure API Review Board is dedicated to helping you create amazing APIs. You can read about our mission and learn more about our process on our wiki.

Click here for links to tools, specs, guidelines & other good stuff

Tooling

Guidelines & Specifications

Helpful Links

fix https://github.com/Azure/azure-rest-api-specs/issues/21313

bexxx avatar Oct 27 '22 13:10 bexxx

Hi, @bexxx 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 Oct 27 '22 13:10 openapi-workflow-bot[bot]

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand] 
    There are no breaking changes.
    ️❌Breaking Change(Cross-Version): 1 Errors, 95 Warnings failed [Detail]
    compared swaggers (via Oad v0.10.2)] new version base version
    azureopenai.json 2022-12-01(e5388d1) 2022-06-01-preview(main)

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

    Only 30 items are listed, please refer to log for more details.

    Rule Message
    ❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/e5388d18f117f1c3face60f47dd45839b2ffd5cf/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2022-12-01/inference.json",
    "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json",
    "details":"Command failed: node /mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.46/common/temp/node_modules/.pnpm/@[email protected]/node_modules/autorest/dist/app.js --v2 --input-file=/mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nFATAL: swagger-document/loader - FAILED\nFATAL: Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json' is not a valid OpenAPI 2.0 definition (expected 'swagger: 2.0')\n Error: File 'file:///mnt/vss/_work/1/cross-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/inference/preview/2022-06-01-preview/inference.json' is not a valid OpenAPI 2.0 defi"
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/deployments/{deployment_id}' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L96:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/files/{file_id}' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L348:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/files/{file_id}/content' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L429:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fine_tune_id}' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L618:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fine_tune_id}/events' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L699:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fine_tune_id}/cancel' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L749:5
    :warning: 1005 - RemovedPath The new version is missing a path that was found in the old version. Was path '/models/{model_id}' removed or restructured?
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L828:5
    :warning: 1010 - AddingRequiredParameter The required parameter 'deployment' was added in the new version.
    New: authoring/stable/2022-12-01/azureopenai.json#L60:11
    :warning: 1010 - AddingRequiredParameter The required parameter 'fileImport' was added in the new version.
    New: authoring/stable/2022-12-01/azureopenai.json#L493:11
    :warning: 1010 - AddingRequiredParameter The required parameter 'fineTune' was added in the new version.
    New: authoring/stable/2022-12-01/azureopenai.json#L582:11
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L933:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L926:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L939:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L932:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L77:15
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L75:15
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1192:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1166:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1198:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1172:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L330:15
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L327:15
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L510:15
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L506:15
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1305:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1257:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1311:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1263:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1145:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1117:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L599:15
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L594:15
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1651:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1533:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1657:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1539:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1007:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L995:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1012:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1001:9
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1879:5
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1761:5
    :warning: 1023 - TypeFormatChanged The new version has a different format than the previous one.
    New: authoring/stable/2022-12-01/azureopenai.json#L1249:9
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1217:9
    :warning: 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: authoring/stable/2022-12-01/azureopenai.json#L1127:7
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1104:7
    :warning: 1025 - RequiredStatusChange The 'required' status changed from the old version('False') to the new version('True').
    New: authoring/stable/2022-12-01/azureopenai.json#L1141:7
    Old: authoring/preview/2022-06-01-preview/azureopenai.json#L1113:7
    ️️✔️CredScan succeeded [Detail] [Expand] 
    There is no credential detected.
    ️⚠️LintDiff: 38 Warnings warning [Detail]
    compared tags (via openapi-validator v2.0.0) new version base version
    release_2022_12_01 release_2022_12_01(e5388d1) default(main)

    [must fix]The following errors/warnings are introduced by current PR:

    Only 30 items are listed, please refer to log for more details.

    Rule Message Related RPC [For API reviewers]
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L109
    :warning: ParameterNamesConvention Parameter name 'deployment-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L111
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L127
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L153
    :warning: ParameterNamesConvention Parameter name 'deployment-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L155
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L180
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L187
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L210
    :warning: ParameterNamesConvention Parameter name 'deployment-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L212
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L225
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L362
    :warning: ParameterNamesConvention Parameter name 'file-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L364
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L380
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L403
    :warning: ParameterNamesConvention Parameter name 'file-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L405
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L418
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L444
    :warning: ParameterNamesConvention Parameter name 'file-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L446
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L462
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L634
    :warning: ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L636
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L652
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L675
    :warning: ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L677
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L690
    :warning: PageableOperation Based on the response model schema, operation 'FineTunes_GetEvents' might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L705
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L705
    :warning: PathParameterSchema Path parameter should specify a maximum length (maxLength) and characters allowed (pattern).
    Location: authoring/stable/2022-12-01/azureopenai.json#L716
    :warning: ParameterNamesConvention Parameter name 'fine-tune-id' should be camel case.
    Location: authoring/stable/2022-12-01/azureopenai.json#L718
    :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: authoring/stable/2022-12-01/azureopenai.json#L723


    The following errors/warnings exist before current PR submission:

    Rule Message
    :warning: PageableOperation Based on the response model schema, operation 'Deployments_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L10
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L10
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L31
    :warning: Post201Response Using post for a create operation is discouraged.
    Location: authoring/stable/2022-12-01/azureopenai.json#L71
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L84
    :warning: PageableOperation Based on the response model schema, operation 'Files_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L240
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L240
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L261
    :warning: Formdata Check for appropriate use of formData parameters.
    Location: authoring/stable/2022-12-01/azureopenai.json#L290
    :warning: Formdata Check for appropriate use of formData parameters.
    Location: authoring/stable/2022-12-01/azureopenai.json#L315
    :warning: Post201Response Using post for a create operation is discouraged.
    Location: authoring/stable/2022-12-01/azureopenai.json#L324
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L337
    :warning: Post201Response Using post for a create operation is discouraged.
    Location: authoring/stable/2022-12-01/azureopenai.json#L504
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L517
    :warning: PageableOperation Based on the response model schema, operation 'FineTunes_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L532
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L532
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L553
    :warning: Post201Response Using post for a create operation is discouraged.
    Location: authoring/stable/2022-12-01/azureopenai.json#L593
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L606
    :warning: PageableOperation Based on the response model schema, operation 'Models_List' might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L798
    :warning: PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
    Location: authoring/stable/2022-12-01/azureopenai.json#L798
    :warning: ErrorResponse Error response should contain a x-ms-error-code header.
    Location: authoring/stable/2022-12-01/azureopenai.json#L819
    :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: authoring/stable/2022-12-01/azureopenai.json#L893
    :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: authoring/stable/2022-12-01/azureopenai.json#L897
    :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: authoring/stable/2022-12-01/azureopenai.json#L901
    :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: authoring/stable/2022-12-01/azureopenai.json#L905
    :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: authoring/stable/2022-12-01/azureopenai.json#L1491
    ️❌Avocado: 1 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ MISSING_README Can not find readme.md in the folder. If no readme.md file, it will block SDK generation.
    folder: AzureOpenAI/inference/stable/2022-12-01
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand] 
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️~[Staging] SwaggerAPIView succeeded [Detail] [Expand]
    ️❌ModelValidation: 2 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in Completions_Create.
    Url: inference/stable/2022-12-01/inference.json#L30:15
    ❌ XMS_EXAMPLE_NOTFOUND_ERROR x-ms-example not found in embeddings_create.
    Url: inference/stable/2022-12-01/inference.json#L351:15
    ️❌SemanticValidation: 8 Errors, 0 Warnings failed [Detail]
    Rule Message
    ❌ OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: swagger
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: openapi
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: servers
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: components
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: requestBody
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: schema
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_ADDITIONAL_PROPERTIES Additional properties not allowed: content
    JsonUrl: inference/stable/2022-12-01/inference.json
    ❌ OBJECT_MISSING_REQUIRED_PROPERTY Missing required property: type
    JsonUrl: inference/stable/2022-12-01/inference.json
    ️️✔️PoliCheck succeeded [Detail] [Expand] 
    Validation passed for PoliCheck.
    ️️✔️PrettierCheck succeeded [Detail] [Expand] 
    Validation passes for PrettierCheck.
    ️️✔️SpellCheck succeeded [Detail] [Expand] 
    Validation passes for SpellCheck.
    ️️✔️Lint(RPaaS) succeeded [Detail] [Expand] 
    Validation passes for Lint(RPaaS).
    ️️✔️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 Oct 27 '22 13:10 openapi-pipeline-app[bot]

    Swagger pipeline restarted successfully, please wait for status update in this comment.

    openapi-pipeline-app[bot] avatar Oct 27 '22 13:10 openapi-pipeline-app[bot]

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

    openapi-pipeline-app[bot] avatar Oct 27 '22 13:10 openapi-pipeline-app[bot]

    Hi @bexxx, 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 Oct 27 '22 13:10 openapi-workflow-bot[bot]

    @bexxx please coordinate with the API Stewardship Board to get their sign-off on this GA release.

    tjprescott avatar Oct 27 '22 17:10 tjprescott

    Hi,

    I've scheduled the review for 11/22. Will finish the PR soon with enough time to look at it beforehand.

    Thanks! Ralf

    Von meinem iPhone gesendet

    Am 27.10.2022 um 19:11 schrieb Travis Prescott @.***>:

    

    @bexxxhttps://github.com/bexxx please coordinate with the API Stewardship Board to get their sign-off on this GA release.

    — Reply to this email directly, view it on GitHubhttps://github.com/Azure/azure-rest-api-specs/pull/21312#issuecomment-1293829049, or unsubscribehttps://github.com/notifications/unsubscribe-auth/ACQ753BJYEYEKZ2AAWGQUETWFKZT7ANCNFSM6AAAAAARQCJN2E. You are receiving this because you were mentioned.Message ID: @.***>

    bexxx avatar Oct 27 '22 18:10 bexxx

    I addressed them all. Please verify the fixes are ok.

    In reply to: 1190739556

    bexxx avatar Nov 23 '22 14:11 bexxx

    Yes, we had to use their way of specifying the types.

    In reply to: 1191867663

    bexxx avatar Nov 23 '22 16:11 bexxx

    /azp run

    mikekistler avatar Nov 23 '22 22:11 mikekistler

    Azure Pipelines successfully started running 1 pipeline(s).

    azure-pipelines[bot] avatar Nov 23 '22 22:11 azure-pipelines[bot]

    Hi, @bexxx, For review efficiency consideration, when creating a new api version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki. Or you could onboard API spec pipeline

    openapi-workflow-bot[bot] avatar Nov 29 '22 15:11 openapi-workflow-bot[bot]

    Hi @bexxx, one or multiple validation error/warning suppression(s) is detected in your PR. Please follow the Swagger-Suppression-Process to get approval.

    openapi-workflow-bot[bot] avatar Nov 29 '22 15:11 openapi-workflow-bot[bot]

    We verified the issues with the PR manually:

    • breaking changes: the previous version is a preview version. The tooling does not consider this. Changes are accepted.
    • APIDoc generation: fails because it cannot handle OpenApi v3 inference docs (requires oneOf), there is no way to exclude it. There is already manually written docs for this API part. Failure accepted.
    • Avocado: missing readme to exclude sdk generation for inference part. There is already an existing manually written SDK. Failures accepted.
    • ModelValidation: tooling has issues with OpenApi v3 part. Failures accepted.
    • SemanticValidation: tooling has issues with OpenApi v3 part. Failures accepted.

    bexxx avatar Nov 30 '22 08:11 bexxx

    @mikekistler We got approval from you and Johan, on this GA api-version. Should I proceed with the merge?

    I will try ignore the CI failures, as it reports on "inference.json" which is OpenAPI 3.0

    weidongxu-microsoft avatar Nov 30 '22 10:11 weidongxu-microsoft

    ignore Avocado ModelValidation SemanticValidation, as inference.json is OpenAPI 3.0

    weidongxu-microsoft avatar Dec 01 '22 01:12 weidongxu-microsoft