FormRecognizerReceipt - Initial Commit. #6042

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.

Sign up for GitHub

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

Jump to bottom

Merged

sergey-shandar merged 69 commits into Azure:master from ramparab:master

May 30, 2019

Contributor

ramparab commented May 21, 2019

Latest improvements:

MSFT employees can try out our new experience at OpenAPI Hub - one location for using our validation tools and finding your workflow.

Contribution checklist:

I have reviewed the documentation for the workflow.
Validation tools were run on swagger spec(s) and have all been fixed in this PR.
The OpenAPI Hub was used for checking validation status and next steps.

ARM API Review Checklist

Service team MUST add the "WaitForARMFeedback" label if the management plane API changes fall into one of the below categories.
adding/removing APIs.
adding/removing properties.
adding/removing API-version.
adding a new service in Azure.

Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs.

If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them.
Please follow the link to find more details on API review process.

Sandeep Parab and others added 30 commits

April 17, 2019 12:39


          Initial commit.

c30a385


          Incorporating PR feedback

00e4cf3


          Adding examples, cleanup.

8dbcee7


          Fixing json syntax errors.

90946c6


          Incorporating feedback.


          Refactor swagger to common type.

843f2f7


          Incorporating feedback.

2c78f40


          Moved to preview, refactor, fixes.

3840cae


          Updated text.

29ea35b


          Minor text change.

6efacb5


          More minor text updates.

292f8ba


          Reverting accidental change

781f7db


          Refactor

10c7f52


          Refactor, Adding GetModels REST API placeholder

e137884


          Refactor, fixes

3753fc5


          Refactor, Updated definitions.

5ed88d4


          Fix type definition

9864cca


          model* API endpoint updated

da9d7d3


          Fix build issue, Reverting change to face swagger

81b6743


          updated namespace

4d75131


          Updated return type for /models api

29e2bc7


          Update FormRecognizer.json

4e65e77

fix paths of methods (add custom) and fix path of hosttemplate


          Merge pull request #1 from Bastortz2/patch-2

3ae0d35

Update FormRecognizer.json


          Refactor, opid changes.

4c99141


          removing multi as it causing autorest codegen issues with langs like …

…go, ruby etc.


          reverting face.json changes.

9b1f37a


          renamed example, fixed typo in example to make it valid json

355ce60


          API review feedback, Reverting OpIds

afc041b


          API review feedback, fixing examples for model verification

c5ddd4b


          Fixing examples for model validation

0f9441c

Sandeep Parab added 2 commits

May 28, 2019 10:27


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

abdd49f


          Fixing receipt API verification issues.

5f88348

Contributor Author

ramparab commented May 28, 2019

@dsgouda: yes this has been through API review and got approved. @bojunehsu on this thread drove the whole process.

Contributor Author

ramparab commented May 28, 2019

@dsgouda: I looked into squashing the commit history for just my changes but it looked bit tricky. Any suggestions are appreciated.

Contributor

dsgouda commented May 28, 2019

@dsgouda: I looked into squashing the commit history for just my changes but it looked bit tricky. Any suggestions are appreciated.

git rebase -i <first_commit_id> should work, what issues are you running into

Contributor

dsgouda commented May 28, 2019

@ramparab please fix the linter issues here

dsgouda suggested changes

View reviewed changes

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json Outdated Show resolved Hide resolved

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json

    
                  }

                ],

                "x-ms-parameterized-host": {

                  "hostTemplate": "{Endpoint}/formrecognizer/v1.0-preview",

Contributor

dsgouda May 28, 2019

Are URLs dependent on api version

Member

bojunehsu May 29, 2019

Yes, this is the convention for Cognitive Services.

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json Show resolved Hide resolved

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json

    
                      ],

                      "responses": {

                        "202": {

                          "description": "The service has accepted the request and will start processing later. It will return 'Accepted' immediately and include an 'Operation-Location' header. Client side should further query the operation status using the URL specified in this header. The 'Operation-Location' URL will expire in 48 hours.",

Contributor

dsgouda May 28, 2019

This looks like a long running operation

Member

bojunehsu May 29, 2019

It is. Due to consistency with existing Cognitive Service APIs, we are not able to adopt the latest conventions. The API review board has agreed with this design.

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json Show resolved Hide resolved

...fication/cognitiveservices/data-plane/FormRecognizer/preview/v1.0/FormRecognizerReceipt.json Show resolved Hide resolved

specification/cognitiveservices/data-plane/FormRecognizer/readme.md

    
              ``` yaml $(tag) == 'release_1_0'

              input-file: preview/v1.0/FormRecognizer.json

              input-file:

Contributor

dsgouda May 28, 2019

Though it's implied, it is a good idea to include ocr.json

Member

bojunehsu May 29, 2019

Previously, we were hoping to only reference a subset of definitions from the CV ocr.json. But as the build validation scripts end up validating even unreferenced definitions, we are removing them. So we can add ocr.json explicitly to the list of input files.

Contributor

dsgouda May 29, 2019

A. Why does ocr.json have unreferenced definitions?
B. Regardless of whether these definitions are used, violations must be addressed

Contributor

dsgouda May 30, 2019

@ramparab could you address this too?

Contributor Author

ramparab May 30, 2019

done.

Sandeep Parab added 5 commits

May 29, 2019 21:23


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

9b2e05f


          fixing build issues

a5efc53


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

9c2b0e4


          removing empty lines.

b93b646


          adding description for understandingResult

e83304c

This was referenced May 30, 2019

[AutoPR cognitiveservices/data-plane/FormRecognizer] FormRecognizerReceipt - Initial Commit. Azure/azure-sdk-for-python#5549

Merged

[AutoPR cognitiveservices/data-plane/FormRecognizer] FormRecognizerReceipt - Initial Commit. Azure/azure-sdk-for-go#4911

Merged


          Adding reference to Ocr swagger.

abd110f

Contributor

dsgouda commented May 30, 2019

@ramparab there are still linter errors being reported here

Sandeep Parab added 7 commits

May 30, 2019 10:56


          Trimming OCR to remove unreferenced definitions.

f346e31


          Adding missing definitions.

bf2cd12


          Fixing build issues.

e6f6927


          Merge branch 'master' of https://github.com/Azure/azure-rest-api-specs

67e3772


          Adding updated OCR reference.

ef8d9f6


          fix version

1dca244


          fixing typo

f2a1c72

dsgouda approved these changes

View reviewed changes

Contributor

dsgouda left a comment

LGTM

dsgouda approved these changes

View reviewed changes

Contributor

dsgouda left a comment

LGTM

dsgouda removed the APIStewardshipBoard-ReviewRequested label


          capturing feedback from API PR review.

6b22120

sergey-shandar merged commit c347aa2 into Azure:master

ramparab mentioned this pull request

FormRecognizer Receipt SDK PR Azure/azure-sdk-for-net#6379

Closed

mccleanp pushed a commit that referenced this pull request


          removing old unused versions since newer version exists (#6042)

b025a5a

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet