ATS-28 : Design: Initial Draft API contract to get / list registered transforms

- added api spec to list transform options for a transformer
This commit is contained in:
DenisGabriela 2018-12-18 16:51:34 +02:00
parent 843cb516e4
commit 56e8860477

View File

@ -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