mirror of
https://github.com/Alfresco/alfresco-transform-core.git
synced 2025-05-26 17:24:47 +00:00
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:
parent
843cb516e4
commit
56e8860477
@ -124,6 +124,33 @@ paths:
|
|||||||
description: Unexpected error
|
description: Unexpected error
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/definitions/Error'
|
$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:
|
definitions:
|
||||||
Error:
|
Error:
|
||||||
type: object
|
type: object
|
||||||
@ -194,3 +221,13 @@ definitions:
|
|||||||
type: integer
|
type: integer
|
||||||
errorDetails:
|
errorDetails:
|
||||||
type: string
|
type: string
|
||||||
|
transformOption:
|
||||||
|
type: object
|
||||||
|
required:
|
||||||
|
- required
|
||||||
|
- name
|
||||||
|
properties:
|
||||||
|
required:
|
||||||
|
type: boolean
|
||||||
|
name:
|
||||||
|
type: string
|
Loading…
x
Reference in New Issue
Block a user