inteligr8/alfresco-transform-core
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-transform-core.git synced 2025-05-26 17:24:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

ATS-17: Add private OpenAPI spec for Alfresco Transform Engines API

Browse Source 
- updates based on initial review comments, including
-- fix typo (s/successful/failed)
-- add example error status code
-- add link to Alfresco SFS API spec
- also slight re-wording of /transform description
This commit is contained in:
janv 2018-09-11 11:31:46 +01:00
parent dc12a2743a
commit a93989e045
1 changed files with 10 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
docs/alfresco-transformer.yaml
View File

@ -35,14 +35,18 @@ paths:
description: | description: |
**Note:** available with Alfresco Transform Engines 2.0 and newer versions. **Note:** available with Alfresco Transform Engines 2.0 and newer versions.
This endpoint supports both JSON and multipart/form-data. This endpoint supports both JSON and Multipart. The JSON API is used within the
Alfresco Transform Service (eg. ACS 6.1). The Multipart API remains for backwards
compatibility (eg. ACS 6.0).
**Using JSON (application/json -> application/json)** **Using JSON (application/json -> application/json)**
The JSON API relies on the source and target files to be stored and retrieved via
the Shared File Store. This is used within the Alfresco Transform Service.
The ACS Content Repository 6.1 (or higher) provides the option to offload The ACS Content Repository 6.1 (or higher) provides the option to offload
supported transformations to the Alfresco Transform Service. supported transformations to the Alfresco Transform Service.
The JSON API is used within the Alfresco Transform Service. It relies on the
source and target files being stored and retrieved via the Alfresco Shared File
Store (see also [alfresco-sfs.yaml](https://github.com/Alfresco/alfresco-shared-file-store/blob/master/docs/api-definitions/alfresco-sfs.yaml)).
Here's a pseudo-example transform request: Here's a pseudo-example transform request:
@ -65,7 +69,7 @@ paths:
} }
``` ```
Here's an pseudo-example response of a successful transform: Here's a pseudo-example response of a successful transform:
```JSON ```JSON
{ {
@ -78,11 +82,12 @@ paths:
} }
``` ```
Here's an pseudo-example response of a successful transform: Here's a pseudo-example response of a failed transform:
```JSON ```JSON
{ {
"schema": 1, "schema": 1,
"status": 400,
"errorDetails": "Lorem ipsum dolor sit amet, ..." "errorDetails": "Lorem ipsum dolor sit amet, ..."
"requestId": "0aead31c-e3ca-42c9-8e16-c1938ff64c3a", "requestId": "0aead31c-e3ca-42c9-8e16-c1938ff64c3a",
"clientData": "opaque-client-specific-data-123xyz", "clientData": "opaque-client-specific-data-123xyz",