From a93989e0453232edc07ee0b401a4a122e0782ad9 Mon Sep 17 00:00:00 2001 From: janv Date: Tue, 11 Sep 2018 11:31:46 +0100 Subject: [PATCH] ATS-17: Add private OpenAPI spec for Alfresco Transform Engines API - 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 --- docs/alfresco-transformer.yaml | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/docs/alfresco-transformer.yaml b/docs/alfresco-transformer.yaml index f73c9b5d..224c576e 100644 --- a/docs/alfresco-transformer.yaml +++ b/docs/alfresco-transformer.yaml @@ -35,14 +35,18 @@ paths: description: | **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)** - 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 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: @@ -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 { @@ -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 { "schema": 1, + "status": 400, "errorDetails": "Lorem ipsum dolor sit amet, ..." "requestId": "0aead31c-e3ca-42c9-8e16-c1938ff64c3a", "clientData": "opaque-client-specific-data-123xyz",