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

Video Analysis 2024_05_01 - public preview #29109

Draft
wants to merge 19 commits into
base: main
Choose a base branch
from

Conversation

fredericoliveira
Copy link

@fredericoliveira fredericoliveira commented May 15, 2024

Data Plane API Specification Update Pull Request

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.

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.

fix #28915

Copy link

openapi-pipeline-app bot commented May 15, 2024

Next Steps to Merge

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

Important checks have failed. As of today they are not blocking this PR, but in near future they will.
Addressing the following failures is highly recommended:
  • ⚠️ The check named TypeSpec Requirement (data-plane) has failed. TypeSpec usage is required for all new (greenfield) services. This is currently enforced as a warning for data-plane specs, but will be made a blocking error in the near future. For information on converting from OpenAPI specs to TypeSpec specs or on data-plane (DP) policies, refer to aka.ms/azsdk/typespec. If you have general questions on resource provider (RP) policies, refer to aka.ms/rphelp

Copy link

openapi-pipeline-app bot commented May 15, 2024

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️⚠️LintDiff: 52 Warnings warning [Detail]
Compared specs (v2.2.2) new version base version
2024-05-01-preview 2024-05-01-preview(2b24191) 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]
⚠️ PutRequestResponseScheme A PUT operation request body schema should be the same as its 200 response schema, to allow reusing the same entity between GET and PUT. If the schema of the PUT request body is a superset of the GET response body, make sure you have a PATCH operation to make the resource updatable. Operation: 'CreateTask' Request Model: 'parameters[2].schema' Response Model: 'responses[201].schema'
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L10
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L16
⚠️ DefaultResponse Operation is missing a default response.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L46
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L49
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L67
⚠️ DefaultResponse Operation is missing a default response.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L85
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L88
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L105
⚠️ DefaultResponse Operation is missing a default response.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L120
⚠️ ListInOperationName Since operation response has model definition in array type, it should be of the form '_list'.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L133
⚠️ PageableOperation Based on the response model schema, operation 'ListTasks' might be pageable. Consider adding the x-ms-pageable extension.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L133
⚠️ PaginationResponse Operation might be pageable. Consider adding the x-ms-pageable extension.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L133
⚠️ OperationId OperationId should be of the form 'Noun_Verb'
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L139
⚠️ AdditionalPropertiesAndProperties Don't specify additionalProperties as a sibling of properties.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L171
⚠️ ErrorResponse Error response should contain a x-ms-error-code header.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L175
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L191
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L213
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L222
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L226
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L268
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L288
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L381
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L390
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L409
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L418
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L425
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L438
⚠️ PropertyDescription Property should have a description.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L447
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L459
⚠️ SchemaDescriptionOrTitle Schema should have a description or title.
Location: VideoAnalysis/preview/2024-05-01-preview/UnifiedVision-VideoAnalysis.json#L501
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️️✔️SwaggerAPIView succeeded [Detail] [Expand]
️❌TypeSpecAPIView: 0 Errors, 1 Warnings failed [Detail]
Rule Message
⚠️ Failed to generate TypeSpec APIView. Please check the detail log and make sure TypeSpec compiler version is the latest. "How to fix":"Check the detailed log and verify if the TypeSpec emitter is able to create API review file for the changes in PR."
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented May 15, 2024

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?

Copy link

openapi-pipeline-app bot commented May 15, 2024

Generated ApiView

Language Package Name ApiView Link
Swagger UnifiedVision https://apiview.dev/Assemblies/Review/87673c38577d4267ab70a0745c126ec7?revisionId=192a6846ef4b4b8b9a11132f4815bd4f

@fredericoliveira fredericoliveira marked this pull request as draft May 15, 2024 14:59
@fredericoliveira fredericoliveira changed the title Frolivei/review/2024 05 01 public preview Video Analysis 2024_05_01 - public preview May 15, 2024
@AzureRestAPISpecReview AzureRestAPISpecReview added the TypeSpec Authored with TypeSpec label May 23, 2024
@mikekistler mikekistler linked an issue May 23, 2024 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
data-plane TypeSpec Authored with TypeSpec
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Unified Vision Service - Video Intelligence] API Review
2 participants