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.

Sign up for GitHub

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

Jump to bottom

Add OperationState field back to AOAI May preview api version #29185

Merged
merged 1 commit into from
May 21, 2024
Merged

Add OperationState field back to AOAI May preview api version #29185

merged 1 commit into from
May 21, 2024
+35 −1

Conversation

YunsongB
Copy link
Contributor

Data Plane API Specification Update Pull Request

Add OperationState field back to AOAI May preview api version

Tip

Overwhelmed by all this guidance? See the Getting help section at the bottom of this PR description.

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

spec_pr_review_workflow_diagram

API Info: The Basics

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

  • Link to API Spec engagement record issue:

Is this review for (select one):

  • a private preview
  • a public preview
  • 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 API Spec document (if applicable), and the root paths that have been updated.

  • Design Document:
  • Previous API Spec Doc:
  • Updated paths:

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

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

❔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

Getting help

  • First, please carefully read through this PR description, from top to bottom.
  • To understand what you must do next to merge this PR, see the Next Steps to Merge comment. It will appear within few minutes of submitting this PR and will continue to be up-to-date with current PR state.
  • For guidance on fixing this PR CI check failures, see the hyperlinks provided in given failure
    and https://aka.ms/ci-fix.
  • If the PR CI checks appear to be stuck in queued state, please add a comment with contents /azp run.
    This should result in a new comment denoting a PR validation pipeline has started and the checks should be updated after few minutes.
  • If the help provided by the previous points is not enough, post to https://aka.ms/azsdk/support/specreview-channel and link to this PR.

@YunsongB YunsongB requested a review from yangyuan as a code owner May 21, 2024 17:53
@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 21, 2024 •
edited

Next Steps to Merge

Next steps that must be taken to merge this PR:
  • ❌ The required check named Swagger PrettierCheck has failed. Refer to the check in the PR's 'Checks' tab for details on how to fix it

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 21, 2024 •
edited

Swagger Validation Report

️❌BreakingChange: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ Runtime Exception "new":"https://github.com/Azure/azure-rest-api-specs/blob/4b0fd28da0eedeea1b0b9439257f3836ce50b5b0/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json",
"old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json",
"details":"Breaking change detector (OAD) invoked AutoRest. AutoRest threw a runtime error. First 20 lines of stack trace follow,
indexed. First line should contain AutoRest command line invocation details. Remaining lines should contain the main message reported by AutoRest.
====================
1: Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@Azure+oad@0.10.8/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp/oad-rhL4N2
2: ERROR: Schema violation: Expected type boolean but found type string
3:
4: code: 'INVALID-TYPE',

5: params: [ 'boolean',
'string' ],

6: message: 'Expected type boolean but found type string',

7: path: '#/definitions/TargetType/x-ms-enum/modelAsString',

8: schemaId: 'https://raw.githubusercontent.com/Azure/autorest/master/schema/swagger-extensions.json#'
9:
10: - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json:2127:6 ($.definitions.TargetType["x-ms-enum"].modelAsString)
11: FATAL: swagger-document/individual/schema-validator - FAILED
12: FATAL: Error: [OperationAbortedException] Error occurred. Exiting.
13: Process() cancelled due to exception : [OperationAbortedException] Error occurred. Exiting."
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand] 
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand] 
There is no credential detected.
️❌LintDiff: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ LintDiffToolException "details":""stack":"MissingPointerError: Token \"OperationState\" does not exist.\n at Pointer.resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/pointer.js:94:13)\n at $Ref.resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/ref.js:124:20)\n at $Refs._resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/refs.js:156:15)\n at dereference$Ref (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:140:23)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:69:28)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)\n at dereference$Ref (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:160:24)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:69:28)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)",
"code":"EMISSINGPOINTER",
"message":"Token \"OperationState\" does not exist.",
"source":"/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json",
"path":null,
"name":"MissingPointerError",
"footprint":"null+/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json+EMISSINGPOINTER+Token \"OperationState\" does not exist.""
️️✔️Avocado succeeded [Detail] [Expand] 
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️❌ModelValidation: 14 Errors, 0 Warnings failed [Detail]
Rule Message
❌ DISCRIMINATOR_VALUE_NOT_FOUND Discriminator value "UserCompute" not found
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1962:21
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_jobs.json#L11:15
❌ DISCRIMINATOR_VALUE_NOT_FOUND Discriminator value "SystemCompute" not found
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1962:21
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_jobs.json#L16:15
❌ REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND In operation IngestionJobs_Create, parameter job-id is required in the swagger spec but is not present in the provided example parameter values.
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L811:16
ExampleUrl: preview/2024-05-01-preview/examples/put_ingestion_job_sc.json#L827:17
❌ DISCRIMINATOR_VALUE_NOT_FOUND Discriminator value "SystemCompute" not found
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1962:21
ExampleUrl: preview/2024-05-01-preview/examples/put_ingestion_job_sc.json#L42:13
❌ REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND In operation IngestionJobs_Create, parameter job-id is required in the swagger spec but is not present in the provided example parameter values.
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L811:16
ExampleUrl: preview/2024-05-01-preview/examples/put_ingestion_job_uc.json#L827:17
❌ DISCRIMINATOR_VALUE_NOT_FOUND Discriminator value "UserCompute" not found
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1962:21
ExampleUrl: preview/2024-05-01-preview/examples/put_ingestion_job_uc.json#L28:13
❌ REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND In operation IngestionJobs_Get, parameter job-id is required in the swagger spec but is not present in the provided example parameter values.
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L877:16
ExampleUrl: preview/2024-05-01-preview/examples/get_ingestion_job.json#L890:17
❌ DISCRIMINATOR_VALUE_NOT_FOUND Discriminator value "UserCompute" not found
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1962:21
ExampleUrl: preview/2024-05-01-preview/examples/get_ingestion_job.json#L9:13
❌ REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND In operation IngestionJobRuns_List, parameter job-id is required in the swagger spec but is not present in the provided example parameter values.
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L920:16
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_job_runs.json#L933:17
❌ ENUM_CASE_MISMATCH Enum does not match case for: Succeeded
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1851:23
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_job_runs.json#L13:17
❌ ENUM_CASE_MISMATCH Enum does not match case for: Failed
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1851:23
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_job_runs.json#L18:17
❌ ENUM_CASE_MISMATCH Enum does not match case for: Running
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1851:23
ExampleUrl: preview/2024-05-01-preview/examples/list_ingestion_job_runs.json#L23:17
❌ REQUIRED_PARAMETER_EXAMPLE_NOT_FOUND In operation IngestionJobRuns_Get, parameter job-id is required in the swagger spec but is not present in the provided example parameter values.
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L969:16
ExampleUrl: preview/2024-05-01-preview/examples/get_ingestion_job_run.json#L982:17
❌ ENUM_CASE_MISMATCH Enum does not match case for: Running
Url: authoring/preview/2024-05-01-preview/azureopenai.json#L1851:23
ExampleUrl: preview/2024-05-01-preview/examples/get_ingestion_job_run.json#L12:15
️❌SemanticValidation: 1 Errors, 0 Warnings failed [Detail]
Rule Message
❌ INVALID_TYPE Expected type boolean but found type string
JsonUrl: authoring/preview/2024-05-01-preview/azureopenai.json#L2161:24
️️✔️PoliCheck succeeded [Detail] [Expand] 
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand] 
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail]
Rule Message
❌ LintRpaasToolException "details":""stack":"MissingPointerError: Token \"OperationState\" does not exist.\n at Pointer.resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/pointer.js:94:13)\n at $Ref.resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/ref.js:124:20)\n at $Refs._resolve (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/refs.js:156:15)\n at dereference$Ref (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:140:23)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:69:28)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)\n at dereference$Ref (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:160:24)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:69:28)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)\n at crawl (/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.99/common/temp/node_modules/.pnpm/@APIDevTools+json-schema-ref-parser@9.1.2/node_modules/@apidevtools/json-schema-ref-parser/lib/dereference.js:78:30)",
"code":"EMISSINGPOINTER",
"message":"Token \"OperationState\" does not exist.",
"source":"/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json",
"path":null,
"name":"MissingPointerError",
"footprint":"null+/mnt/vss/_work/1/azure-rest-api-specs/specification/cognitiveservices/data-plane/AzureOpenAI/authoring/preview/2024-05-01-preview/azureopenai.json+EMISSINGPOINTER+Token \"OperationState\" does not exist.""
️❌PR Summary: 0 Errors, 0 Warnings failed [Detail]
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

openapi-pipeline-app bot commented May 21, 2024 •
edited

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand] 
 Please click here to preview with your @microsoft account.
Posted by Swagger Pipeline | How to fix these errors?

@openapi-pipeline-app openapi-pipeline-app
Copy link

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

@lmazuel lmazuel merged commit 36682ca into Azure:main May 21, 2024
23 of 32 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trrwilson trrwilson trrwilson approved these changes

@yangyuan yangyuan Awaiting requested review from yangyuan yangyuan is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@YunsongB @trrwilson @lmazuel