Skip to content

Split Ocr out into own Swagger file #4158

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

Merged
jhendrixMSFT merged 1 commit into from
Oct 11, 2018
Merged

Split Ocr out into own Swagger file #4158

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion specification/cognitiveservices/data-plane/ComputerVision/readme.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,9 @@ openapi-type: data-plane
These settings apply only when `--tag=release_2_0` is specified on the command line.

``` yaml $(tag) == 'release_2_0'
input-file: stable/v2.0/ComputerVision.json
input-file:
- stable/v2.0/ComputerVision.json
- stable/v2.0/Ocr.json
```

## Swagger to SDK
Expand Down
190 changes: 0 additions & 190 deletions specification/cognitiveservices/data-plane/ComputerVision/stable/v2.0/ComputerVision.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -357,85 +357,6 @@
}
}
}
},
"/recognizeText": {
"post": {
"description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.",
"operationId": "RecognizeText",
"parameters": [
{
"$ref": "#/parameters/ImageUrl"
},
{
"$ref": "#/parameters/TextRecognitionMode"
}
],
"consumes": [
"application/json"
],
"produces": [
"application/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 ID will expire in 48 hours.",
"headers": {
"Operation-Location": {
"description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ",
"type": "string"
}
}
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/ComputerVisionError"
}
}
},
"x-ms-examples": {
"Successful Domain Model analysis request": {
"$ref": "./examples/SuccessfulRecognizeTextWithUrl.json"
}
}
}
},
"/textOperations/{operationId}": {
"get": {
"description": "This interface is used for getting text operation result. The URL to this interface should be retrieved from 'Operation-Location' field returned from Recognize Text interface.",
"operationId": "GetTextOperationResult",
"parameters": [
{
"name": "operationId",
"in": "path",
"description": "Id of the text operation returned in the response of the 'Recognize Text'",
"required": true,
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Returns the operation status.",
"schema": {
"$ref": "#/definitions/TextOperationResult"
}
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/ComputerVisionError"
}
}
},
"x-ms-examples": {
"Successful Domain Model analysis request": {
"$ref": "./examples/SuccessfulGetTextOperationResult.json"
}
}
}
}
},
"x-ms-paths": {
Expand Down Expand Up @@ -742,120 +663,9 @@
}
}
}
},
"/recognizeText?overload=stream": {
"post": {
"description": "Recognize Text operation. When you use the Recognize Text interface, the response contains a field called 'Operation-Location'. The 'Operation-Location' field contains the URL that you must use for your Get Recognize Text Operation Result operation.",
"operationId": "RecognizeTextInStream",
"parameters": [
{
"$ref": "#/parameters/ImageStream"
},
{
"$ref": "#/parameters/TextRecognitionMode"
}
],
"consumes": [
"application/octet-stream"
],
"produces": [
"application/json"
],
"responses": {
"202": {
"description": "The service has accepted the request and will start processing later.",
"headers": {
"Operation-Location": {
"description": "URL to query for status of the operation. The operation ID will expire in 48 hours. ",
"type": "string"
}
}
},
"default": {
"description": "Error response.",
"schema": {
"$ref": "#/definitions/ComputerVisionError"
}
}
},
"x-ms-examples": {
"Successful Domain Model analysis request": {
"$ref": "./examples/SuccessfulRecognizeTextWithStream.json"
}
}
}
}
},
"definitions": {
"TextOperationResult": {
"type": "object",
"properties": {
"status": {
"type": "string",
"description": "Status of the text operation.",
"enum": [
"Not Started",
"Running",
"Failed",
"Succeeded"
],
"x-ms-enum": {
"name": "TextOperationStatusCodes",
"modelAsString": false
},
"x-nullable": false
},
"recognitionResult": {
"$ref": "#/definitions/RecognitionResult"
}
}
},
"RecognitionResult": {
"type": "object",
"properties": {
"lines": {
"type": "array",
"items": {
"$ref": "#/definitions/Line"
}
}
}
},
"Line": {
"type": "object",
"properties": {
"boundingBox": {
"$ref": "#/definitions/BoundingBox"
},
"text": {
"type": "string"
},
"words": {
"type": "array",
"items": {
"$ref": "#/definitions/Word"
}
}
}
},
"Word": {
"type": "object",
"properties": {
"boundingBox": {
"$ref": "#/definitions/BoundingBox"
},
"text": {
"type": "string"
}
}
},
"BoundingBox": {
"type": "array",
"items": {
"type": "integer",
"x-nullable": false
}
},
"ImageAnalysis": {
"type": "object",
"description": "Result of AnalyzeImage operation.",
Expand Down
Loading