[TypeSpec-Clean] Update OpenAI.Authoring#23969
[TypeSpec-Clean] Update OpenAI.Authoring#23969markcowl merged 3 commits intoAzure:mainfrom markcowl:tsp-clean-oaia
Conversation
|
Hi, @markcowl Thanks for your PR. I am workflow bot for review process. Here are some small tips. Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com |
Swagger Validation Report
|
| compared swaggers (via Oad v0.10.4)] | new version | base version |
|---|---|---|
| openapi.json | 2022-06-01-preview(b8d4684) | 2022-06-01-preview(main) |
| Rule | Message |
|---|---|
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/deployments' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L58:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/deployments/{deploymentId}' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L184:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/files' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L399:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/files/{fileId}' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L528:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/files/{fileId}/content' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L589:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/files/import' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L622:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/fine-tunes' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L664:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fineTuneId}' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L728:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fineTuneId}/cancel' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L789:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/fine-tunes/{fineTuneId}/events' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L822:5 |
1005 - RemovedPath
|
The new version is missing a path that was found in the old version. Was path '/models' removed or restructured? Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L862:5 |
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: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L888:5 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'FileImport' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'FineTuneCreation' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'HyperParameters' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'ManualScaleSettings' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'ManualScaleSettingsUpdate' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'Purpose' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1006 - RemovedDefinition
|
The new version is missing a definition that was found in the old version. Was 'StandardScaleSettings' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L45:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L922:3 |
1007 - RemovedClientParameter
|
The new version is missing a client parameter that was found in the old version. Was 'Azure.Core.Foundations.ApiVersionParameter' removed or renamed? New: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L46:3 Old: cognitiveservices/OpenAI.Authoring/cadl-output/openapi.json#L2070:3 |
Runtime Exception |
"new":"https://github.com/Azure/azure-rest-api-specs/blob/b8d468411815598ec1a2d66dd5619813b7716fb8/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json", "old":"https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json", "details":"Command failed: node "/mnt/vss/_work/_tasks/AzureApiValidation_5654d05d-82c1-48da-ad8f-161b817f6d41/0.0.52/common/temp/node_modules/.pnpm/@Azure+oad@0.10.4/node_modules/autorest/dist/app.js" --v2 --input-file=/mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json --output-artifact=swagger-document.json --output-artifact=swagger-document.map --output-file=old --output-folder=/tmp\nERROR: Schema violation: Missing required property: name\n - file:///mnt/vss/_work/1/same-version-c93b354fd9c14905bb574a8834c4d69b/specification/cognitiveservices/OpenAI.Authoring/cadl-output/2022-06-01-preview/openapi.json:1744:10 ( |
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️️✔️LintDiff succeeded [Detail] [Expand]
Validation passes for LintDiff.
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
Validation passes for ServiceAPIReadinessTest.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️️✔️CadlAPIView succeeded [Detail] [Expand]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️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.
️️✔️TypeSpec Validation succeeded [Detail] [Expand]
Validation passes for TypeSpec Validation.
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
|
Swagger pipeline restarted successfully, please wait for status update in this comment. |
|
Swagger pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment. |
|
Hi @markcowl, Your PR has some issues. Please fix the CI sequentially by following the order of
|
| "@azure-tools/typespec-autorest": | ||
| azure-resource-provider-folder: "cadl-output" | ||
| emitter-output-dir: "{project-root}" | ||
| output-file: "{azure-resource-provider-folder}/{version}/openapi.json" |
There was a problem hiding this comment.
Should this output to this folder instead?
If so, I think this whole directory should be deleted:
There was a problem hiding this comment.
It is up to you - the swagger here does not (and never did) match the swagger in the associated data-plane directory. We could emit it to a different folder in data-plane, but I feel like having the swagger in this directory or removing it altogether are the least bad options.
There was a problem hiding this comment.
I'm confused. If the swagger generated from TypeSpec does not match the swagger in the data-plane directory, why is it being generated at all? Why does this TypeSpec folder exist in the repo at all?
There was a problem hiding this comment.
I am guessing that the swagger was there before and this is a proof of concept. There are multiple versions in the data-plane folder, and this spec does not even represent the latest one.
There was a problem hiding this comment.
OK, I'm fine merging this PR as-is with one additional change to remove this file I believe is an extra copy that shouldn't be there:
There was a problem hiding this comment.
Later we will need to decide what to do with specs that are proof-of-concept or client-only (don't emit swagger).
There was a problem hiding this comment.
If this is a proof of concept I would argue we should have it merged into the main branch. If we plan to ship this we should have it outputting specs where they are supposed to be going and should definitely not have the name "cadl-output" in the path.
There was a problem hiding this comment.
@lmazuel: Do you know the history of the OpenAI.Authoring spec, and who is maintaining it going forward?
There was a problem hiding this comment.
Let me ask on our internal chat
| "@azure-tools/typespec-autorest": | ||
| azure-resource-provider-folder: "cadl-output" | ||
| emitter-output-dir: "{project-root}" | ||
| output-file: "{azure-resource-provider-folder}/{version}/openapi.json" |
There was a problem hiding this comment.
OK, I'm fine merging this PR as-is with one additional change to remove this file I believe is an extra copy that shouldn't be there:
|
Hi @markcowl, 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. |
- Spec removed from repo in Azure#23969
- Spec removed from repo in #23969
Uh oh!
There was an error while loading. Please reload this page.