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

Form Recognizer 2022-08-31 #20404

Merged
merged 1 commit into from
Nov 10, 2022
Merged

Conversation

bojunehsu
Copy link
Member

@bojunehsu bojunehsu commented Aug 26, 2022

Data Plane API - Pull Request

  • Removed support for Office/HTML input and table footnote/caption (previously supported in 2022-06-30-preview)
  • Renamed Swagger definitions to improve auto generated SDK class naming (no behavioral change)
  • Implement polymorphism in OperationDetails to support different result types (no behavior change)

API Info: The Basics

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

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 Open API document (swagger) if applicable, and the root paths that have been updated.

❔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

@openapi-workflow-bot
Copy link

Hi, @bojunehsu Thanks for your PR. I am workflow bot for review process. Here are some small tips.

  • Please ensure to do self-check against checklists in first PR comment.
  • PR assignee is the person auto-assigned and responsible for your current PR reviewing and merging.
  • For specs comparison cross API versions, Use API Specs Comparison Report Generator
  • If there is CI failure(s), to fix CI error(s) is mandatory for PR merging; or you need to provide justification in PR comment for explanation. How to fix?

  • Any feedback about review process or workflow bot, pls contact swagger and tools team. vscswagger@microsoft.com

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 26, 2022

    Swagger Validation Report

    ️️✔️BreakingChange succeeded [Detail] [Expand]
    There are no breaking changes.
    ️⚠️Breaking Change(Cross-Version): 34 Warnings warning [Detail]
    compared swaggers (via Oad v0.9.7)] new version base version
    FormRecognizer.json 2022-08-31(2fd7dcd) 2022-06-30-preview(main)

    The following breaking changes are detected by comparison with the latest preview version:

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

    Rule Message
    ⚠️ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'text/html' as a request body format.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L41:9
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L41:9
    ⚠️ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' as a request body format.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L41:9
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L41:9
    ⚠️ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' as a request body format.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L41:9
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L41:9
    ⚠️ 1003 - RequestBodyFormatNoLongerSupported The new version does not support 'application/vnd.openxmlformats-officedocument.presentationml.presentation' as a request body format.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L41:9
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L41:9
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ModelId' removed or renamed?
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L607:3
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L611:3
    ⚠️ 1006 - RemovedDefinition The new version is missing a definition that was found in the old version. Was 'ModelDescription' removed or renamed?
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L607:3
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L611:3
    ⚠️ 1007 - RemovedClientParameter The new version is missing a client parameter that was found in the old version. Was 'PathModelId' removed or renamed?
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L2134:3
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L2131:3
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'GetModels' to 'GetDocumentModels'. This will impact generated code.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L447:7
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L451:7
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'GetModel' to 'GetDocumentModel'. This will impact generated code.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L489:7
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L493:7
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'DeleteModel' to 'DeleteDocumentModel'. This will impact generated code.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L531:7
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L535:7
    ⚠️ 1008 - ModifiedOperationId The operation id has been changed from 'GetInfo' to 'GetResourceDetails'. This will impact generated code.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L569:7
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L573:7
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L58:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L124:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L1321:9
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L1201:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L170:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L223:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L276:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L325:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L379:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L421:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L462:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L504:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L546:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L584:9
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L2144:5
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L2141:5
    ⚠️ 1019 - RemovedEnumValue The new version is removing enum value(s) '2022-06-30-preview' from the old version.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L911:5
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L812:5
    ⚠️ 1030 - DifferentDiscriminator The new version has a different discriminator than the previous one.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L428:13
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L432:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L428:13
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L432:13
    ⚠️ 1032 - DifferentAllOf The new version has a different 'allOf' property than the previous one.
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L511:13
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L515:13
    ⚠️ 1033 - RemovedProperty The new version is missing a property found in the old version. Was 'kind' renamed or removed?
    New: FormRecognizer/stable/2022-08-31/FormRecognizer.json#L1395:7
    Old: FormRecognizer/preview/2022-06-30-preview/FormRecognizer.json#L1276:7
    ️️✔️CredScan succeeded [Detail] [Expand]
    There is no credential detected.
    ️️✔️LintDiff succeeded [Detail] [Expand]
    Validation passes for LintDiff.
    compared tags (via openapi-validator v1.13.0) new version base version
    2022-08-31 2022-08-31(2fd7dcd) default(main)
    ️️✔️Avocado succeeded [Detail] [Expand]
    Validation passes for Avocado.
    ️️✔️ApiReadinessCheck succeeded [Detail] [Expand]
    ️️✔️~[Staging] ServiceAPIReadinessTest succeeded [Detail] [Expand]
    Validation passes for ServiceAPIReadinessTest.
    ️️✔️ModelValidation succeeded [Detail] [Expand]
    Validation passes for ModelValidation.
    ️️✔️SemanticValidation succeeded [Detail] [Expand]
    Validation passes for SemanticValidation.
    ️️✔️PoliCheck succeeded [Detail] [Expand]
    Validation passed for PoliCheck.
    ️⚠️SDK Track2 Validation: 1 Warnings warning [Detail]
    • The following tags are being changed in this PR
      • "https://github.com/Azure/azure-rest-api-specs/blob/2fd7dcd89afa70ff5ba7be88bee987da62099a28/specification/cognitiveservices/data-plane/FormRecognizer/readme.md#tag-2022-08-31">cognitiveservices/data-plane/FormRecognizer/readme.md#2022-08-31
    The following errors/warnings are introduced by current PR:
    Rule Message
    ⚠️ UnkownSecurityScheme "readme":"cognitiveservices/data-plane/FormRecognizer/readme.md",
    "tag":"2022-08-31",
    "details":"Security scheme apim_key is unknown and will not be processed. Only supported types are AADToken,
    AzureKey,
    Anonymous"
    ️️✔️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.
    Posted by Swagger Pipeline | How to fix these errors?

    @openapi-pipeline-app
    Copy link

    openapi-pipeline-app bot commented Aug 26, 2022

    Swagger Generation Artifacts

    ️️✔️ApiDocPreview succeeded [Detail] [Expand]
     Please click here to preview with your @microsoft account. 
    ️️✔️SDK Breaking Change Tracking succeeded [Detail] [Expand]

    Breaking Changes Tracking

    ️⚠️ azure-sdk-for-net-track2 warning [Detail]
    • ⚠️Warning [Logs]Release - Generate from 64484dc. 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
      warn	File azure-sdk-for-net_tmp/initOutput.json not found to read
      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?

    @openapi-pipeline-app
    Copy link

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

    Copy link
    Member

    @catalinaperalta catalinaperalta left a comment

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    LGTM

    @bojunehsu
    Copy link
    Member Author

    @jhendrixMSFT Can you please help approve this PR or move it forward? Thanks.

    @ghost
    Copy link

    ghost commented Oct 2, 2022

    Hi, @bojunehsu. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @ghost
    Copy link

    ghost commented Oct 23, 2022

    Hi, @bojunehsu. Your PR has no update for 14 days and it is marked as stale PR. If no further update for over 14 days, the bot will close the PR. If you want to refresh the PR, please remove no-recent-activity label.

    @mikekistler
    Copy link
    Member

    @jhendrixMSFT I think this PR is ready to merge. Overdue actually since we have already generated and shipped SDKs using this API definition ☹️ .

    @jhendrixMSFT jhendrixMSFT merged commit 64484dc into main Nov 10, 2022
    @jhendrixMSFT jhendrixMSFT deleted the paulhsu/FormRecognizer-2022-08-31 branch November 10, 2022 16:32
    anandanthony pushed a commit to anandMicro/azure-rest-api-specs that referenced this pull request Dec 16, 2022
    kayousef-zz pushed a commit to kayousef-zz/azure-rest-api-specs that referenced this pull request Dec 21, 2022
    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
    Projects
    None yet
    Development

    Successfully merging this pull request may close these issues.

    7 participants