azure-rest-api-specs
azure-rest-api-specs copied to clipboard
Azure
Update documentation for FormRecognizer v2.1
Data Plane API - Pull Request
Update documentation for FormRecognizer v2.1
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
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
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.
Next Steps to Merge
✅ All automated merging requirements have been met! To get your PR merged, see aka.ms/azsdk/specreview/merge.![openapi-pipeline-app[bot] avatar](https://avatars.githubusercontent.com/in/65541?v=4 "Published by a pub.dev verified publisher"){kind=small}
Swagger Validation Report
️❌BreakingChange: 21 Errors, 0 Warnings failed [Detail]
| Compared specs (v0.10.8) | new version | base version |
|---|---|---|
| FormRecognizer.json | v2.1(cbc5dc7) | v2.1(main) |
| Rule | Message |
|---|---|
|
The operation id has been changed from 'TrainCustomModelAsync' to 'CustomModels_Train'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L34:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L34:7 |
|
The operation id has been changed from 'GetCustomModel' to 'CustomModels_Get'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L83:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L84:7 |
|
The operation id has been changed from 'DeleteCustomModel' to 'CustomModels_Delete'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L129:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L131:7 |
|
The operation id has been changed from 'AnalyzeWithCustomModel' to 'CustomModels_AnalyzeDocument'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L165:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L168:7 |
|
The operation id has been changed from 'GetAnalyzeFormResult' to 'CustomModels_GetAnalyzeResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L230:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L234:7 |
|
The operation id has been changed from 'CopyCustomModel' to 'CustomModels_Copy'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L277:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L282:7 |
|
The operation id has been changed from 'GetCustomModelCopyResult' to 'CustomModels_GetCopyResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L331:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L337:7 |
|
The operation id has been changed from 'GenerateModelCopyAuthorization' to 'CustomModels_AuthorizeModelCopy'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L381:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L388:7 |
|
The operation id has been changed from 'ComposeCustomModelsAsync' to 'CustomModels_Compose'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L417:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L425:7 |
|
The operation id has been changed from 'AnalyzeBusinessCardAsync' to 'Analyzer_AnalyzeBusinessCard'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L462:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L474:7 |
|
The operation id has been changed from 'GetAnalyzeBusinessCardResult' to 'Analyzer_GetAnalyzeBusinessCardResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L522:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L535:7 |
|
The operation id has been changed from 'AnalyzeInvoiceAsync' to 'Analyzer_AnalyzeInvoice'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L561:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L575:7 |
|
The operation id has been changed from 'GetAnalyzeInvoiceResult' to 'Analyzer_GetAnalyzeInvoiceResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L621:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L636:7 |
|
The operation id has been changed from 'AnalyzeIdDocumentAsync' to 'Analyzer_AnalyzeIdDocument'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L660:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L676:7 |
|
The operation id has been changed from 'GetAnalyzeIdDocumentResult' to 'Analyzer_GetAnalyzeIdDocumentResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L717:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L734:7 |
|
The operation id has been changed from 'AnalyzeReceiptAsync' to 'Analyzer_AnalyzeReceipt'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L756:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L774:7 |
|
The operation id has been changed from 'GetAnalyzeReceiptResult' to 'Analyzer_GetAnalyzeReceiptResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L816:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L835:7 |
|
The operation id has been changed from 'AnalyzeLayoutAsync' to 'Analyzer_AnalyzeLayout'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L855:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L875:7 |
|
The operation id has been changed from 'GetAnalyzeLayoutResult' to 'Analyzer_GetAnalyzeLayoutResult'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L909:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L930:7 |
|
The operation id has been changed from 'ListCustomModels' to 'CustomModels_List'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L950:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L972:7 |
|
The operation id has been changed from 'GetCustomModels' to 'CustomModels_GetSummary'. This will impact generated code. New: FormRecognizer/stable/v2.1/FormRecognizer.json#L995:7 Old: FormRecognizer/stable/v2.1/FormRecognizer.json#L1018: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.1) | new version | base version |
|---|---|---|
| release_2_1 | release_2_1(cbc5dc7) | release_2_1(main) |
The following errors/warnings exist before current PR submission:
Only 30 items are listed, please refer to log for more details.
| Rule | Message |
|---|---|
|
The host parameter must be typed 'type 'string', format 'url''. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L24 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L958 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1003 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1366 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1371 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1605 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1847 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1867 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1873 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1903 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1909 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1915 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1922 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L1986 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L2041 |
|
The enum types should have x-ms-enum type extension set with appropriate options. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L2060 |
|
The integer type does not have a format, please add it. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L2093 |
| :warning: VersionConvention | API version should be a date in YYYY-MM-DD format, optionally suffixed with '-preview'. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L4 |
| :warning: SecurityDefinitionDescription | Security definition should have a description. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L9 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L43 |
| :warning: Post201Response | Using post for a create operation is discouraged. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L55 |
| :warning: SuccessResponseBody | All success responses except 202 & 204 should define a response body. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L55 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L64 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L90 |
| :warning: PathParameterSchema | Path parameter should specify a maximum length (maxLength) and characters allowed (pattern). Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L91 |
| :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: FormRecognizer/stable/v2.1/FormRecognizer.json#L99 |
| :warning: Nullable | Avoid the use of x-nullable. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L106 |
| :warning: SchemaTypeAndFormat | Schema with type: number should specify format Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L112 |
| :warning: ErrorResponse | Error response should contain a x-ms-error-code header. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L116 |
| :warning: VersionPolicy | Operation does not define an 'api-version' query parameter. Location: FormRecognizer/stable/v2.1/FormRecognizer.json#L136 |
️️✔️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]
Swagger Generation Artifacts
️🔄ApiDocPreview inProgress [Detail]
️⚠️ azure-sdk-for-net-track2 warning [Detail]
⚠️Warning in generating from dc93a8ccf083df359b1fdac27166701f915c1977. SDK Automation 14.0.0command 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
PR validation pipeline restarted successfully. If there is ApiView generated, it will be updated in this comment.