From 56e8860477d7be8961557bdc584f0d43b3760402 Mon Sep 17 00:00:00 2001 From: DenisGabriela Date: Tue, 18 Dec 2018 16:51:34 +0200 Subject: [PATCH 1/4] ATS-28 : Design: Initial Draft API contract to get / list registered transforms - added api spec to list transform options for a transformer --- docs/alfresco-transformer.yaml | 37 ++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/alfresco-transformer.yaml b/docs/alfresco-transformer.yaml index 224c576e..090fce22 100644 --- a/docs/alfresco-transformer.yaml +++ b/docs/alfresco-transformer.yaml @@ -124,6 +124,33 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' + '/transformer/{transformer}/options': + get: + tags: + - Transform + description: List transform options for specified transformer + operationId: transformOptions + produces: + - application/xml + - application/json + parameters: + - name: transformer + in: path + description: Name of the transformer + required: true + type: string + responses: + 200: + description: Successful response + schema: + type: array + xml: + name: transformOptions + wrapped: true + items: + $ref: '#/definitions/TransformOption' + 404: + description: Transformer not found definitions: Error: type: object @@ -194,3 +221,13 @@ definitions: type: integer errorDetails: type: string + transformOption: + type: object + required: + - required + - name + properties: + required: + type: boolean + name: + type: string \ No newline at end of file From 55a1b7d2f98bec1c9ee4bdef0cc9b5e93d29330a Mon Sep 17 00:00:00 2001 From: DenisGabriela Date: Tue, 18 Dec 2018 17:35:33 +0200 Subject: [PATCH 2/4] ATS-28 : Design: Initial Draft API contract to get / list registered transforms --- docs/alfresco-transformer.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/alfresco-transformer.yaml b/docs/alfresco-transformer.yaml index 090fce22..0de1a939 100644 --- a/docs/alfresco-transformer.yaml +++ b/docs/alfresco-transformer.yaml @@ -148,7 +148,7 @@ paths: name: transformOptions wrapped: true items: - $ref: '#/definitions/TransformOption' + $ref: '#/definitions/transformOption' 404: description: Transformer not found definitions: From db91ef32c4d96b2b98c2d5717da3706f6dc8f914 Mon Sep 17 00:00:00 2001 From: DenisGabriela Date: Wed, 19 Dec 2018 10:20:31 +0200 Subject: [PATCH 3/4] ATS-28 : Design: Initial Draft API contract to get / list registered transforms --- docs/alfresco-transformer.yaml | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/alfresco-transformer.yaml b/docs/alfresco-transformer.yaml index 0de1a939..b04c4e22 100644 --- a/docs/alfresco-transformer.yaml +++ b/docs/alfresco-transformer.yaml @@ -131,7 +131,6 @@ paths: description: List transform options for specified transformer operationId: transformOptions produces: - - application/xml - application/json parameters: - name: transformer From bef28f3ca5a602c3a9c57f489be80e0b427c332a Mon Sep 17 00:00:00 2001 From: DenisGabriela Date: Fri, 21 Dec 2018 11:31:38 +0200 Subject: [PATCH 4/4] ATS-28 : Design: Initial Draft API contract to get / list registered transforms - removed transformer parameter and 404 response --- docs/alfresco-transformer.yaml | 12 ++---------- 1 file changed, 2 insertions(+), 10 deletions(-) diff --git a/docs/alfresco-transformer.yaml b/docs/alfresco-transformer.yaml index b04c4e22..d5adc79d 100644 --- a/docs/alfresco-transformer.yaml +++ b/docs/alfresco-transformer.yaml @@ -124,20 +124,14 @@ paths: description: Unexpected error schema: $ref: '#/definitions/Error' - '/transformer/{transformer}/options': + '/transformer/options': get: tags: - Transform - description: List transform options for specified transformer + description: List transform options operationId: transformOptions produces: - application/json - parameters: - - name: transformer - in: path - description: Name of the transformer - required: true - type: string responses: 200: description: Successful response @@ -148,8 +142,6 @@ paths: wrapped: true items: $ref: '#/definitions/transformOption' - 404: - description: Transformer not found definitions: Error: type: object