diff --git a/README.md b/README.md
index 6b9c9048e..1928c4338 100644
--- a/README.md
+++ b/README.md
@@ -2,7 +2,7 @@
## How to develop
-For local development, simply use :
+For local development, simply use:
```bash
$ yarn install
diff --git a/src/pages/apis/index.md b/src/pages/apis/index.md
index 76ea35820..61eaf1db1 100644
--- a/src/pages/apis/index.md
+++ b/src/pages/apis/index.md
@@ -1,6 +1,6 @@
---
title: Adobe PDF Services Open API spec
description: The OpenAPI spec for Adobe PDF Services API endpoints, parameters, and responses.
-openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/main/src/pages/resources/openapi.json
+openAPISpec: https://raw.githubusercontent.com/AdobeDocs/pdfservices-api-documentation/palaka/onemd/src/pages/resources/openapi.json
---
-[]
diff --git a/src/pages/resources/openapi.json b/src/pages/resources/openapi.json
index 0ec0dca16..801cd9cb3 100644
--- a/src/pages/resources/openapi.json
+++ b/src/pages/resources/openapi.json
@@ -38,6 +38,10 @@
"name": "Extract PDF",
"description": "Extract content from PDF documents and output it in a structured JSON format, along with tables and figures"
},
+ {
+ "name": "PDF To Markdown",
+ "description": "Convert PDF documents to Markdown format"
+ },
{
"name": "Html to PDF",
"description": "Convert HTML Resources to a PDF File"
@@ -130,6 +134,7 @@
"Export PDF",
"Export PDF Form Data",
"Extract PDF",
+ "PDF To Markdown",
"Html to PDF",
"Import PDF Form Data",
"Linearize PDF",
@@ -938,14 +943,392 @@
}
}
},
- "/operation/documentgeneration": {
+ "/operation/documentgeneration": {
+ "post": {
+ "tags": [
+ "Document Generation"
+ ],
+ "summary": "Merge Word based templates with input JSON data to create Word and PDF documents",
+ "description": "Merges the input JSON data with Word based templates to create dynamic documents. To learn more about document generation and document templates, please see the documentation.",
+ "operationId": "pdfoperations.documentgeneration",
+ "parameters": [
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "Bearer + Token (Learn more about getting the access token)",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "description": "The clientId from the generated credentials",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "requestBody": {
+ "description": "Params for Document Generation Operation. Refer to the External Section below for using external storage with Document Generation API",
+ "content": {
+ "application/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/DocumentGenerationInternal"
+ },
+ {
+ "$ref": "#/components/schemas/DocumentGenerationExternal"
+ }
+ ]
+ }
+ }
+ },
+ "required": true
+ },
+ "responses": {
+ "201": {
+ "description": "Request creation for the operation and status uri generated, which can be found in the 'location' header.",
+ "headers": {
+ "location": {
+ "description": "Job status URI for polling the results",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request. The request was invalid or cannot be otherwise served.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/400"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/404"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the error JSON response.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/401"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Caller doesn't have sufficient quota for this operation.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/429"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/500"
+ }
+ }
+ }
+ }
+ },
+ "x-codegen-request-body-name": "body"
+ }
+ },
+ "/operation/documentgeneration/{jobID}/status": {
+ "get": {
+ "tags": [
+ "Document Generation"
+ ],
+ "summary": "Poll the document generation job for completion",
+ "operationId": "pdfoperations.documentgeneration.jobstatus",
+ "parameters": [
+ {
+ "name": "jobID",
+ "in": "path",
+ "description": "Job ID of the request",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "Authorization",
+ "in": "header",
+ "description": "Bearer + Token (Learn more about getting the access token)",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ },
+ {
+ "name": "x-api-key",
+ "in": "header",
+ "description": "The clientId from the generated credentials",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A response with job information.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the status call response.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/DocumentGenerationJobStatus"
+ }
+ }
+ }
+ },
+ "400": {
+ "description": "Bad Request. The request was invalid or cannot be otherwise served.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the status call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Status400"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Resource Not Found.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Satus404"
+ }
+ }
+ }
+ },
+ "401": {
+ "description": "Unauthorized.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-server": {
+ "description": "The name and version of the server.",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Satus401"
+ }
+ }
+ }
+ },
+ "429": {
+ "description": "Caller doesn't have sufficient quota for this operation.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Satus429"
+ }
+ }
+ }
+ },
+ "500": {
+ "description": "Internal Server Error. The server has encountered an error and is unable to process your request at this time.",
+ "headers": {
+ "content-type": {
+ "description": "The content type of the POST API call response",
+ "schema": {
+ "type": "string"
+ }
+ },
+ "x-request-id": {
+ "description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
+ "schema": {
+ "type": "string"
+ }
+ }
+ },
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/Satus500"
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "/operation/pdftomarkdown": {
"post": {
"tags": [
- "Document Generation"
+ "PDF To Markdown"
],
- "summary": "Merge Word based templates with input JSON data to create Word and PDF documents",
- "description": "Merges the input JSON data with Word based templates to create dynamic documents. To learn more about document generation and document templates, please see the documentation.",
- "operationId": "pdfoperations.documentgeneration",
+ "summary": "Extract content from PDF documents and output it in a markdown format, along with tables and figures",
+ "description": "Extract PDF Content, Tables content and Tables/Figures renditions from a PDF document. Various available options are: \n\n1. Extract figures or images in base64 format",
+ "operationId": "pdfoperations.pdftomarkdown",
"parameters": [
{
"name": "Authorization",
@@ -967,16 +1350,16 @@
}
],
"requestBody": {
- "description": "Params for Document Generation Operation. Refer to the External Section below for using external storage with Document Generation API",
+ "description": "Params for PDF to Markdown Operation. Refer to the External Section below for using external storage with PDF to Markdown Operation.",
"content": {
"application/json": {
"schema": {
"oneOf": [
{
- "$ref": "#/components/schemas/DocumentGenerationInternal"
+ "$ref": "#/components/schemas/PDFToMarkdownInternal"
},
{
- "$ref": "#/components/schemas/DocumentGenerationExternal"
+ "$ref": "#/components/schemas/PDFToMarkdownExternal"
}
]
}
@@ -1059,6 +1442,12 @@
"type": "string"
}
},
+ "x-server": {
+ "description": "The name and version of the server.",
+ "schema": {
+ "type": "string"
+ }
+ },
"x-request-id": {
"description": "A unique value to identify this request. If x-request-id is specified in the POST request, this value will be the same as the input.",
"schema": {
@@ -1126,13 +1515,13 @@
"x-codegen-request-body-name": "body"
}
},
- "/operation/documentgeneration/{jobID}/status": {
+ "/operation/pdftomarkdown/{jobID}/status": {
"get": {
"tags": [
- "Document Generation"
+ "PDF To Markdown"
],
- "summary": "Poll the document generation job for completion",
- "operationId": "pdfoperations.documentgeneration.jobstatus",
+ "summary": "Poll the PDF to markdown job for completion",
+ "operationId": "pdfoperations.pdftomarkdown.jobstatus",
"parameters": [
{
"name": "jobID",
@@ -1182,7 +1571,7 @@
"content": {
"application/json": {
"schema": {
- "$ref": "#/components/schemas/DocumentGenerationJobStatus"
+ "$ref": "#/components/schemas/PDFToMarkdownJobStatus"
}
}
}
@@ -8897,6 +9286,109 @@
},
"components": {
"schemas": {
+ "PDFToMarkdownInternal": {
+ "title": "Internal",
+ "description": "Params for Extract PDF Operation",
+ "type": "object",
+ "required": [
+ "assetID"
+ ],
+ "properties": {
+ "assetID": {
+ "description": "A file assetID. For more details click here .",
+ "type": "string"
+ },
+ "getFigures": {
+ "description": "Extract figures or images in base64 format",
+ "type": "boolean",
+ "default": "false"
+ },
+ "notifiers": {
+ "$ref": "#/components/schemas/notifiers"
+ }
+ },
+ "example": {
+ "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718",
+ "getfigures": false,
+ "notifiers": [
+ {
+ "type": "CALLBACK",
+ "data": {
+ "url": "https://dummy.callback.org/",
+ "headers": {
+ "x-api-key": "dummykey",
+ "access-token": "dummytoken"
+ }
+ }
+ }
+ ]
+ },
+ "additionalProperties": false
+ },
+ "PDFToMarkdownExternal": {
+ "title": "External",
+ "description": "Params for Extract PDF Operation using external storage.",
+ "type": "object",
+ "required": [
+ "input"
+ ],
+ "properties": {
+ "input": {
+ "$ref": "#/components/schemas/ExternalStorageInput"
+ },
+ "output": {
+ "$ref": "#/components/schemas/ExternalStorageOutputZip"
+ },
+ "params": {
+ "description": "Params for Extract PDF processing",
+ "type": "object",
+ "properties": {
+ "tagEncapsulatedText": {
+ "description": "List of elements from which to extract encapsulated text content.",
+ "type": "array",
+ "items": {
+ "type": "string",
+ "enum": [
+ "Figure"
+ ]
+ },
+ "default": [
+ "Figure"
+ ]
+ }
+ }
+ },
+ "notifiers": {
+ "$ref": "#/components/schemas/notifiers"
+ }
+ },
+ "example": {
+ "input": {
+ "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/1c4f4674-ce8d-4b21-a69d-60aeae35bf43?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081557Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3599&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=ac6998566dbbde22509b128fe94d1cb5d3146cd3fb8ba78d7068e10d61302ec2",
+ "storage": "S3"
+ },
+ "output": {
+ "uri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/dc-platformService-automation_dc-platformService-automation%40AdobeID/f02f9927-4971-4589-8fdf-41ff56c2d520?X-Amz-Security-Token=FwoGZXIvYXdzEBkaDK%2By2wxl94khIbkxzCLTAQn6n6Wo0vFSul%2FpXW66aFX4T%2BPxtuOy%2Bz8eTxrnexeJRvMreBHNQm1myLwp20MkE%2Bb0H%2BwYgOhFaepi9AMml1aLNxXn1UPnEWJ7y8llhvsrXHimEfWvb3TMAkZddgUIDBue8oGUYqm4f2s0sMvPWBCxI45zM0%2F37EK%2B4JnIo1SlrKNm0GSZ44AEiOAhXupQ8ih6KoUbUciD3Biile6CwTMVIhME3mJiRSgVK6W91EaDn8%2Ba3mU%2BVvU1K9sgDSPZ%2F81DOpj25pvMW%2B1cMuCtUNsu9KUo7dHvpAYyLYiy%2FPGEmO9EquKjfMPRr17PAjeunD1QdgbRss4ysG%2B6XF2Has8zsGqX1sQalA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20230628T081559Z&X-Amz-SignedHeaders=content-type%3Bhost&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47IMX73XEA%2F20230628%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=4f765277eb6e36bd5f7bf9d42be24244440092b5a705eadf178c78a9a9fb5d71",
+ "storage": "S3"
+ },
+ "params": {
+ "getfigures": true
+ },
+ "notifiers": [
+ {
+ "type": "CALLBACK",
+ "data": {
+ "url": "https://dummy.callback.org/",
+ "headers": {
+ "x-api-key": "dummykey",
+ "access-token": "dummytoken"
+ }
+ }
+ }
+ ]
+ },
+ "additionalProperties": false
+ },
"Token": {
"description": "Params for generating the Access Token.",
"type": "object",
@@ -13005,6 +13497,19 @@
}
]
},
+ "PDFToMarkdownJobStatus": {
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/inprogress"
+ },
+ {
+ "$ref": "#/components/schemas/done"
+ },
+ {
+ "$ref": "#/components/schemas/failed"
+ }
+ ]
+ },
"HtmlToPdfJobStatus": {
"oneOf": [
{
@@ -14098,6 +14603,17 @@
}
]
},
+ "PDFToMarkdownDone": {
+ "title": "done",
+ "oneOf": [
+ {
+ "$ref": "#/components/schemas/PDFToMarkdownDoneInternal"
+ },
+ {
+ "$ref": "#/components/schemas/PDFToMarkdownDoneExternal"
+ }
+ ]
+ },
"ExtractPDFDoneInternal": {
"title": "Internal",
"description": "Response in case of 'done' status",
@@ -14193,17 +14709,140 @@
}
}
},
- "ExtractPDFDoneExternal": {
+ "PDFToMarkdownDoneInternal": {
+ "title": "Internal",
+ "description": "Response in case of 'done' status",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Job Status",
+ "type": "string",
+ "enum": [
+ "done"
+ ]
+ },
+ "content": {
+ "type": "object",
+ "description": "Asset of json file containig extracted content of pdf file. For more details click here .",
+ "properties": {
+ "metadata": {
+ "type": "object",
+ "description": "metadata details of output asset.",
+ "properties": {
+ "size": {
+ "description": "The size of the Resource in bytes. This value helps in making range requests.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The media type of the Resource.",
+ "type": "string",
+ "enum": [
+ "application/json"
+ ]
+ }
+ }
+ },
+ "assetID": {
+ "description": "An asset ID identifying an asset that is globally unique and never reused.",
+ "type": "string"
+ },
+ "downloadUri": {
+ "description": "The URL used to download the Resource directly to the cloud provider.",
+ "type": "string"
+ }
+ }
+ },
+ "resource": {
+ "type": "object",
+ "description": "Asset of zip file containg generated resources from extract operation. For more details click here .",
+ "properties": {
+ "metadata": {
+ "type": "object",
+ "description": "metadata details of output asset.",
+ "properties": {
+ "size": {
+ "description": "The size of the Resource in bytes. This value helps in making range requests.",
+ "type": "integer"
+ },
+ "type": {
+ "description": "The media type of the Resource.",
+ "type": "string",
+ "enum": [
+ "application/json"
+ ]
+ }
+ }
+ },
+ "assetID": {
+ "description": "An asset ID identifying an asset that is globally unique and never reused.",
+ "type": "string"
+ },
+ "downloadUri": {
+ "description": "The URL used to download the Resource directly to the cloud provider.",
+ "type": "string"
+ }
+ }
+ }
+ },
+ "example": {
+ "status": "done",
+ "content": {
+ "metadata": {
+ "type": "application/json",
+ "size": 200791
+ },
+ "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56",
+ "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718"
+ },
+ "resource": {
+ "metadata": {
+ "type": "application/zip",
+ "size": 200791
+ },
+ "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56",
+ "assetID": "urn:aaid:AS:UE1:23c30ee0-32s3-46d6-87f2-087832fca718"
+ }
+ }
+ },
+ "PDFToMarkdownDoneExternal": {
"title": "External",
"oneOf": [
{
- "$ref": "#/components/schemas/ExtractPDFDoneExternalWithoutOutput"
+ "$ref": "#/components/schemas/PDFToMarkdownDoneExternalWithoutOutput"
},
{
"$ref": "#/components/schemas/external"
}
]
},
+ "PDFToMarkdownDoneExternalWithoutOutput": {
+ "title": "External without an output URI in the request",
+ "description": "Response in case of 'done' status when ouput uri is not passed in the rquest",
+ "type": "object",
+ "properties": {
+ "status": {
+ "description": "Job Status",
+ "type": "string",
+ "enum": [
+ "done"
+ ]
+ },
+ "resource": {
+ "$ref": "#/components/schemas/responseAssetZip"
+ }
+ },
+ "example": {
+ "status": "done",
+ "resource": {
+ "metadata": {
+ "type": "application/pdf",
+ "size": 200791
+ },
+ "downloadUri": "https://dcplatformstorageservice-dev-us-east-1.s3-accelerate.amazonaws.com/6bb12fd8-3233-4340-916b-4835917857be?X-Amz-Security-Token=FwoGZXIvYXdzEE0aDOLg7PFwVB1bjEMxQCLTAe3pjf%2Fgl2Pj%2FcjOaY%2BHfduju9SXTp1Pn8C4GapIXm%2F8tuR4cGPYGC0goU21qZxCq9R%2F8z2bOmB2EL%2BZrhbPLbaNcpzf5Vud%2B3Bmn61MEJiBdU%2BhZqasX5YhVxdnzhfpl5KfKeq2kwROVMqJcyHGdxw5h0%2Bi0sD2I8sqkbPmnBi0WOtYNwz7TQq42oe8W5KYHpq6WMya9OQgx0u7qg0inYwBnQu5UQ9NJJQY2MSU11IuZ0uE%2B%2FNAPuq3VfEIn3txK%2FFfIxGz9%2BInehhHroKjBFULzy0olY2rlwYyLQDwHHr2eyuy%2BaoGVaq%2BSUNH8T0OKIicbbZfQ5wjF0hK2FzVXwfebtDG4qq%2BiA%3D%3D&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20220803T190422Z&X-Amz-SignedHeaders=host&X-Amz-Expires=3600&X-Amz-Credential=ASIAU5PA7W47AH3PA2JV%2F20220803%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Signature=5d8c3f421c68c009b4471919a319ba460495c72afe51674d23266bc124fe9a56",
+ "assetID": "urn:aaid:AS:UE1:23c30ee0-2c4d-46d6-87f2-087832fca718"
+ }
+ }
+ },
"ExtractPDFDoneExternalWithoutOutput" : {
"title": "External without an output URI in the request",
"description": "Response in case of 'done' status when ouput uri is not passed in the rquest",