Data Plane API - Pull Request

Update documentation for FormRecognizer 2022-08-31

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.

💬 Teams Channel
💌 email

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

Tooling

Open API validation tools were run on this PR. Go here to see how to fix errors
Spectral Linting
Open API Hub

Guidelines & Specifications

Helpful Links

Schedule a data plane REST API spec review

Checks stuck in `queued` state?

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.

Apr 23 '24 23:04 MinjingZhu

Next Steps to Merge

✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.

Apr 23 '24 23:04 openapi-pipeline-app[bot]

Swagger Validation Report

️❌BreakingChange: 12 Errors, 0 Warnings failed [Detail]

Compared specs (v0.10.8)	new version	base version
FormRecognizer.json	2022-08-31(ae31f26)	2022-08-31(main)

Rule	Message
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'AnalyzeDocument' to 'DocumentModels_AnalyzeDocument'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L34:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L34:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetAnalyzeDocumentResult' to 'DocumentModels_GetAnalyzeResult'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L105:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L109:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'BuildDocumentModel' to 'DocumentModels_BuildModel'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L145:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L153:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'ComposeDocumentModel' to 'DocumentModels_ComposeModel'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L194:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L206:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'AuthorizeCopyDocumentModel' to 'DocumentModels_AuthorizeModelCopy'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L243:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L259:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'CopyDocumentModelTo' to 'DocumentModels_CopyModelTo'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L288:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L308:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetOperations' to 'Miscellaneous_ListOperations'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L340:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L364:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetOperation' to 'Miscellaneous_GetOperation'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L378:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L406:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetDocumentModels' to 'DocumentModels_ListModels'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L415:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L447:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetDocumentModel' to 'DocumentModels_GetModel'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L453:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L489:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'DeleteDocumentModel' to 'DocumentModels_DeleteModel'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L491:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L531:7
`❌` 1008 - ModifiedOperationId	The operation id has been changed from 'GetResourceDetails' to 'Miscellaneous_GetResourceInfo'. This will impact generated code. New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L525:7 Old: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L569:7

️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]

There are no breaking changes.

️️✔️CredScan succeeded [Detail] [Expand]

There is no credential detected.

️⚠️LintDiff: 0 Warnings warning [Detail]

Compared specs (v2.2.0)	new version	base version
2022-08-31	2022-08-31(ae31f26)	2022-08-31(main)

The following errors/warnings exist before current PR submission:

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

Rule	Message
`❌` HostParametersValidation	The host parameter must be typed 'type 'string', format 'url''. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L24
:warning: SecurityDefinitionDescription	Security definition should have a description. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L9
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L51
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L63
:warning: RequestBodyOptional	The body parameter is not marked as required. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L69
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L86
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L113
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L116
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L119
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L130
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L155
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L178
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L204
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L227
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L253
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L273
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L298
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L301
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L324
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L348
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L359
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L386
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L389
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L400
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L423
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L434
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L461
:warning: ApiVersionEnum	The api-version parameter should not be an enum. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L464
:warning: ErrorResponse	Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L475
:warning: PathParameterSchema	Path parameter should specify a maximum length (maxLength). Location: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L499

️️✔️Avocado succeeded [Detail] [Expand]

Validation passes for Avocado.

️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]

️️✔️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.

️️✔️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?}

Apr 23 '24 23:04 openapi-pipeline-app[bot]

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

 Please click here to preview with your @microsoft account.

️⚠️ azure-sdk-for-net-track2 warning [Detail]

⚠️Warning in generating from f03dbb33cf1ad58573ca14caaa0c9b8ae94ecd4a. SDK Automation 14.0.0

command	pwsh ./eng/scripts/Automation-Sdk-Init.ps1 ../azure-sdk-for-net_tmp/initInput.json ../azure-sdk-for-net_tmp/initOutput.json
command	pwsh ./eng/scripts/Invoke-GenerateAndBuildV2.ps1 ../azure-sdk-for-net_tmp/generateInput.json ../azure-sdk-for-net_tmp/generateOutput.json
warn	No file changes detected after generation
warn	Skip detect changed packages

_{Posted by Swagger Pipeline | How to fix these errors?}

Apr 23 '24 23:04 openapi-pipeline-app[bot]

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

Apr 23 '24 23:04 openapi-pipeline-app[bot]

Updating api-version in examples to 2022-08-31 due to this check failure:

Apr 24 '24 00:04 MinjingZhu

/pr RequestMerge

Apr 29 '24 23:04 MinjingZhu