diff --git a/arkindex/schema.yml b/arkindex/schema.yml
index 84475ef2f5338f6b58bddff7bd44d9dc267acb4f..04909bbdcb5c952ab514024c755c518d859e5e44 100644
--- a/arkindex/schema.yml
+++ b/arkindex/schema.yml
@@ -16,7 +16,7 @@ info:
name: Teklia
url: https://www.teklia.com/
title: Arkindex API
- version: 0.9.6
+ version: 0.9.7.dev2
openapi: 3.0.2
paths:
/api/v1/act/{id}/:
@@ -78,7 +78,7 @@ paths:
type: string
metadata:
readOnly: true
- type: string
+ type: object
name:
type: string
number:
@@ -799,6 +799,8 @@ paths:
display_name:
readOnly: true
type: string
+ folio:
+ type: string
id:
type: string
image:
@@ -846,6 +848,7 @@ paths:
- direction
- image
- classifications
+ - folio
security: []
tags:
- elements
@@ -1045,98 +1048,8 @@ paths:
id:
type: string
metadata:
- items:
- properties:
- dates:
- items:
- properties:
- day:
- nullable: true
- type: integer
- month:
- nullable: true
- type: integer
- type:
- enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
- required:
- - year
- - type
- type: array
- entity:
- properties:
- id:
- type: string
- name:
- type: string
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- required:
- - name
- - type
- type: object
- id:
- type: string
- name:
- type: string
- revision:
- properties:
- author:
- type: string
- commit_url:
- readOnly: true
- type: string
- date:
- format: date-time
- type: string
- hash:
- type: string
- id:
- type: string
- message:
- type: string
- ref:
- type: string
- repo_id:
- readOnly: true
- type: string
- required:
- - date
- - hash
- - ref
- - message
- - author
- type: object
- type:
- enum:
- - text
- - html
- - date
- - location
- - entity
- value:
- type: string
- required:
- - type
- - name
- - value
- - revision
- - dates
- - entity
readOnly: true
- type: array
+ type: object
name:
type: string
thumbnail_put_url:
@@ -1199,98 +1112,8 @@ paths:
id:
type: string
metadata:
- items:
- properties:
- dates:
- items:
- properties:
- day:
- nullable: true
- type: integer
- month:
- nullable: true
- type: integer
- type:
- enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
- required:
- - year
- - type
- type: array
- entity:
- properties:
- id:
- type: string
- name:
- type: string
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- required:
- - name
- - type
- type: object
- id:
- type: string
- name:
- type: string
- revision:
- properties:
- author:
- type: string
- commit_url:
- readOnly: true
- type: string
- date:
- format: date-time
- type: string
- hash:
- type: string
- id:
- type: string
- message:
- type: string
- ref:
- type: string
- repo_id:
- readOnly: true
- type: string
- required:
- - date
- - hash
- - ref
- - message
- - author
- type: object
- type:
- enum:
- - text
- - html
- - date
- - location
- - entity
- value:
- type: string
- required:
- - type
- - name
- - value
- - revision
- - dates
- - entity
readOnly: true
- type: array
+ type: object
name:
type: string
thumbnail_put_url:
@@ -1351,6 +1174,48 @@ paths:
required:
- name
type: object
+ id:
+ type: string
+ metadata:
+ readOnly: true
+ type: object
+ name:
+ type: string
+ thumbnail_put_url:
+ readOnly: true
+ type: string
+ thumbnail_url:
+ readOnly: true
+ type: string
+ type:
+ enum:
+ - volume
+ - register
+ - act
+ - page
+ - surface
+ readOnly: true
+ required:
+ - name
+ tags:
+ - elements
+ /api/v1/element/{id}/entities/:
+ get:
+ description: List all entities linked to an element's transcriptions and metadata
+ operationId: ListElementsEntities
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
id:
type: string
metadata:
@@ -1374,145 +1239,41 @@ paths:
year:
type: integer
required:
- - year
- - type
- type: array
- entity:
- properties:
- id:
- type: string
- name:
- type: string
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- required:
- - name
- - type
- type: object
- id:
- type: string
- name:
- type: string
- revision:
- properties:
- author:
- type: string
- commit_url:
- readOnly: true
- type: string
- date:
- format: date-time
- type: string
- hash:
- type: string
- id:
- type: string
- message:
- type: string
- ref:
- type: string
- repo_id:
- readOnly: true
- type: string
- required:
- - date
- - hash
- - ref
- - message
- - author
- type: object
- type:
- enum:
- - text
- - html
- - date
- - location
- - entity
- value:
- type: string
- required:
- - type
- - name
- - value
- - revision
- - dates
- - entity
- readOnly: true
- type: array
- name:
- type: string
- thumbnail_put_url:
- readOnly: true
- type: string
- thumbnail_url:
- readOnly: true
- type: string
- type:
- enum:
- - volume
- - register
- - act
- - page
- - surface
- readOnly: true
- required:
- - name
- tags:
- - elements
- /api/v1/element/{id}/entities/:
- get:
- description: List all entities linked to an element's transcriptions and metadata
- operationId: ListElementsEntities
- parameters:
- - description: ''
- in: path
- name: id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- id:
- type: string
- metadata:
- items:
- properties:
- dates:
- items:
- properties:
- day:
- nullable: true
- type: integer
- month:
- nullable: true
- type: integer
- type:
- enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
- required:
- - year
- type
+ - year
+ - month
+ - day
type: array
entity:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -1524,6 +1285,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -1584,8 +1347,34 @@ paths:
properties:
entity:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -1597,6 +1386,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2277,6 +2068,7 @@ paths:
- elements
/api/v1/elements/{id}/neighbors/:
get:
+ description: List neighboring elements
operationId: ListElementNeighbors
parameters:
- description: ''
@@ -2415,6 +2207,8 @@ paths:
display_name:
readOnly: true
type: string
+ folio:
+ type: string
id:
type: string
image:
@@ -2462,6 +2256,7 @@ paths:
- direction
- image
- classifications
+ - folio
security: []
tags:
- elements
@@ -2541,8 +2336,32 @@ paths:
properties:
corpus:
type: string
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
metas:
- type: string
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2554,6 +2373,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2570,8 +2391,34 @@ paths:
properties:
child:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2583,6 +2430,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2591,8 +2440,34 @@ paths:
type: string
parent:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2604,6 +2479,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2649,11 +2526,35 @@ paths:
type: array
corpus:
type: string
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
readOnly: true
type: string
metas:
- type: string
+ nullable: true
+ type: object
name:
type: string
parents:
@@ -2661,8 +2562,34 @@ paths:
properties:
child:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2674,6 +2601,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2682,8 +2611,34 @@ paths:
type: string
parent:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2695,6 +2650,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2747,6 +2704,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2798,6 +2757,7 @@ paths:
- entities
/api/v1/entity/search/:
get:
+ description: Get a list of entities
operationId: SearchEntities
parameters:
- description: A page number within the paginated result set.
@@ -2822,7 +2782,7 @@ paths:
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
type:
@@ -2838,11 +2798,11 @@ paths:
- name
- type
tags:
- - entities
+ - search
/api/v1/entity/{id}/:
- get:
- description: Get all information about entity
- operationId: RetrieveEntity
+ delete:
+ description: Delete an entity
+ operationId: DestroyEntity
parameters:
- description: ''
in: path
@@ -2861,8 +2821,34 @@ paths:
properties:
child:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2874,6 +2860,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2882,8 +2870,34 @@ paths:
type: string
parent:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2895,6 +2909,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2948,11 +2964,34 @@ paths:
required:
- name
type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -2960,8 +2999,34 @@ paths:
properties:
child:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2973,6 +3038,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -2981,8 +3048,34 @@ paths:
type: string
parent:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -2994,6 +3087,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -3045,19 +3140,19 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
- corpus
- children
- parents
- security: []
tags:
- entities
- /api/v1/entity/{id}/elements/:
get:
- description: Get all elements that have a link with the entity
- operationId: ListEntityElements
+ description: Get all information about entity
+ operationId: RetrieveEntity
parameters:
- description: ''
in: path
@@ -3065,66 +3160,1594 @@ paths:
required: true
schema:
type: string
- - description: A page number within the paginated result set.
- in: query
- name: page
- required: false
- schema:
- type: integer
- - description: Number of results to return per page.
- in: query
- name: page_size
- required: false
- schema:
- type: integer
responses:
'200':
content:
application/json:
schema:
properties:
- corpus:
- properties:
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- readOnly: true
- required:
- - name
- type: object
- id:
- type: string
- metadata:
+ children:
items:
properties:
- dates:
- items:
- properties:
- day:
- nullable: true
- type: integer
- month:
- nullable: true
- type: integer
- type:
- enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
- required:
- - year
- - type
- type: array
- entity:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ required:
+ - name
+ type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ parents:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ - corpus
+ - children
+ - parents
+ security: []
+ tags:
+ - entities
+ patch:
+ description: Partially update an entity
+ operationId: PartialUpdateEntity
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ children:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ required:
+ - name
+ type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ parents:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ x-name: body
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ children:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ required:
+ - name
+ type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ parents:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ - corpus
+ - children
+ - parents
+ tags:
+ - entities
+ put:
+ description: Update an entity
+ operationId: UpdateEntity
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ children:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ required:
+ - name
+ type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ parents:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ - corpus
+ - children
+ - parents
+ x-name: body
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ children:
+ items:
+ properties:
+ child:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ type: string
+ parent:
+ properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: object
+ required:
+ - parent
+ - child
+ - role
+ type: array
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ required:
+ - name
+ type: object
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
+ id:
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ parents:
+ items:
+ properties:
+ child:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -3136,60 +4759,164 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
type: object
id:
type: string
- name:
- type: string
- revision:
+ parent:
properties:
- author:
- type: string
- commit_url:
- readOnly: true
- type: string
- date:
- format: date-time
- type: string
- hash:
- type: string
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
- message:
+ metas:
+ nullable: true
+ type: object
+ name:
type: string
- ref:
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ role:
+ properties:
+ child_name:
type: string
- repo_id:
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
readOnly: true
+ type: integer
+ parent_name:
type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
required:
- - date
- - hash
- - ref
- - message
- - author
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
type: object
- type:
- enum:
- - text
- - html
- - date
- - location
- - entity
- value:
- type: string
required:
- - type
- - name
- - value
- - revision
- - dates
- - entity
- readOnly: true
+ - parent
+ - child
+ - role
type: array
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ - corpus
+ - children
+ - parents
+ tags:
+ - entities
+ /api/v1/entity/{id}/elements/:
+ get:
+ description: Get all elements that have a link with the entity
+ operationId: ListEntityElements
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ - description: A page number within the paginated result set.
+ in: query
+ name: page
+ required: false
+ schema:
+ type: integer
+ - description: Number of results to return per page.
+ in: query
+ name: page_size
+ required: false
+ schema:
+ type: integer
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ corpus:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ public:
+ type: boolean
+ readOnly: true
+ required:
+ - name
+ type: object
+ id:
+ type: string
+ metadata:
+ readOnly: true
+ type: object
name:
type: string
thumbnail_put_url:
@@ -3510,6 +5237,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
required:
- state
- mode
@@ -3554,6 +5283,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
required:
- state
- mode
@@ -3621,6 +5352,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
workflow:
readOnly: true
type: string
@@ -4648,6 +6381,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
workflow:
readOnly: true
type: string
@@ -4729,6 +6464,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
workflow:
readOnly: true
type: string
@@ -4779,6 +6516,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
required:
- state
- mode
@@ -4846,6 +6585,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
workflow:
readOnly: true
type: string
@@ -6132,8 +7873,34 @@ paths:
properties:
entity:
properties:
+ dates:
+ items:
+ properties:
+ day:
+ nullable: true
+ type: integer
+ month:
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ type: array
id:
type: string
+ metas:
+ nullable: true
+ type: object
name:
type: string
type:
@@ -6145,6 +7912,8 @@ paths:
- misc
- number
- date
+ validated:
+ type: boolean
required:
- name
- type
@@ -6557,6 +8326,7 @@ paths:
action:
enum:
- start_task
+ - stop_task
- kill
task_id:
readOnly: true
@@ -6639,6 +8409,40 @@ paths:
application/json:
schema:
properties:
+ agent:
+ properties:
+ cpu_cores:
+ type: integer
+ cpu_frequency:
+ type: integer
+ farm:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ seed:
+ type: string
+ required:
+ - name
+ type: object
+ gpu_count:
+ type: integer
+ gpu_names:
+ nullable: true
+ type: string
+ hostname:
+ type: string
+ id:
+ readOnly: true
+ type: string
+ required:
+ - farm
+ - hostname
+ - cpu_cores
+ - cpu_frequency
+ - gpu_count
+ type: object
depth:
readOnly: true
type: integer
@@ -6668,6 +8472,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
url:
@@ -6677,10 +8483,12 @@ paths:
- state
- logs
- full_log
+ - agent
security: []
tags:
- ponos
patch:
+ description: Partially update a task
operationId: PartialUpdateTask
parameters:
- description: A UUID string identifying this task.
@@ -6694,6 +8502,40 @@ paths:
application/json:
schema:
properties:
+ agent:
+ properties:
+ cpu_cores:
+ type: integer
+ cpu_frequency:
+ type: integer
+ farm:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ seed:
+ type: string
+ required:
+ - name
+ type: object
+ gpu_count:
+ type: integer
+ gpu_names:
+ nullable: true
+ type: string
+ hostname:
+ type: string
+ id:
+ readOnly: true
+ type: string
+ required:
+ - farm
+ - hostname
+ - cpu_cores
+ - cpu_frequency
+ - gpu_count
+ type: object
full_log:
type: string
logs:
@@ -6706,6 +8548,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
x-name: body
@@ -6715,6 +8559,40 @@ paths:
application/json:
schema:
properties:
+ agent:
+ properties:
+ cpu_cores:
+ type: integer
+ cpu_frequency:
+ type: integer
+ farm:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ seed:
+ type: string
+ required:
+ - name
+ type: object
+ gpu_count:
+ type: integer
+ gpu_names:
+ nullable: true
+ type: string
+ hostname:
+ type: string
+ id:
+ readOnly: true
+ type: string
+ required:
+ - farm
+ - hostname
+ - cpu_cores
+ - cpu_frequency
+ - gpu_count
+ type: object
depth:
readOnly: true
type: integer
@@ -6744,6 +8622,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
url:
@@ -6753,11 +8633,13 @@ paths:
- state
- logs
- full_log
+ - agent
security:
- agentAuth: []
tags:
- ponos
put:
+ description: Update a task
operationId: UpdateTask
parameters:
- description: A UUID string identifying this task.
@@ -6771,6 +8653,40 @@ paths:
application/json:
schema:
properties:
+ agent:
+ properties:
+ cpu_cores:
+ type: integer
+ cpu_frequency:
+ type: integer
+ farm:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ seed:
+ type: string
+ required:
+ - name
+ type: object
+ gpu_count:
+ type: integer
+ gpu_names:
+ nullable: true
+ type: string
+ hostname:
+ type: string
+ id:
+ readOnly: true
+ type: string
+ required:
+ - farm
+ - hostname
+ - cpu_cores
+ - cpu_frequency
+ - gpu_count
+ type: object
full_log:
type: string
logs:
@@ -6783,12 +8699,15 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
required:
- state
- logs
- full_log
+ - agent
x-name: body
responses:
'200':
@@ -6796,6 +8715,40 @@ paths:
application/json:
schema:
properties:
+ agent:
+ properties:
+ cpu_cores:
+ type: integer
+ cpu_frequency:
+ type: integer
+ farm:
+ properties:
+ id:
+ type: string
+ name:
+ type: string
+ seed:
+ type: string
+ required:
+ - name
+ type: object
+ gpu_count:
+ type: integer
+ gpu_names:
+ nullable: true
+ type: string
+ hostname:
+ type: string
+ id:
+ readOnly: true
+ type: string
+ required:
+ - farm
+ - hostname
+ - cpu_cores
+ - cpu_frequency
+ - gpu_count
+ type: object
depth:
readOnly: true
type: integer
@@ -6825,6 +8778,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
url:
@@ -6834,12 +8789,14 @@ paths:
- state
- logs
- full_log
+ - agent
security:
- agentAuth: []
tags:
- ponos
/ponos/v1/task/{id}/artifacts/:
get:
+ description: List all the artifacts of the task
operationId: ListTaskArtifacts
parameters:
- description: ''
@@ -6870,6 +8827,7 @@ paths:
- ponos
/ponos/v1/task/{id}/definition/:
get:
+ description: Retrieve a Ponos task
operationId: RetrieveTaskDefinition
parameters:
- description: A UUID string identifying this task.
@@ -6941,6 +8899,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tasks:
items:
properties:
@@ -6969,6 +8929,8 @@ paths:
- completed
- failed
- error
+ - stopping
+ - stopped
tags:
type: array
url:
@@ -6983,6 +8945,271 @@ paths:
security: []
tags:
- ponos
+ patch:
+ description: Partially update a workflow
+ operationId: PartialUpdateWorkflow
+ parameters:
+ - description: A UUID string identifying this workflow.
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ id:
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tasks:
+ items:
+ properties:
+ depth:
+ readOnly: true
+ type: integer
+ id:
+ readOnly: true
+ type: string
+ parents:
+ items:
+ type: string
+ readOnly: true
+ type: array
+ run:
+ readOnly: true
+ type: integer
+ slug:
+ readOnly: true
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tags:
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - state
+ type: array
+ x-name: body
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ created:
+ format: date-time
+ readOnly: true
+ type: string
+ id:
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tasks:
+ items:
+ properties:
+ depth:
+ readOnly: true
+ type: integer
+ id:
+ readOnly: true
+ type: string
+ parents:
+ items:
+ type: string
+ readOnly: true
+ type: array
+ run:
+ readOnly: true
+ type: integer
+ slug:
+ readOnly: true
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tags:
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - state
+ type: array
+ required:
+ - state
+ - tasks
+ tags:
+ - ponos
+ put:
+ description: Update a workflow's status and tasks
+ operationId: UpdateWorkflow
+ parameters:
+ - description: A UUID string identifying this workflow.
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ id:
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tasks:
+ items:
+ properties:
+ depth:
+ readOnly: true
+ type: integer
+ id:
+ readOnly: true
+ type: string
+ parents:
+ items:
+ type: string
+ readOnly: true
+ type: array
+ run:
+ readOnly: true
+ type: integer
+ slug:
+ readOnly: true
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tags:
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - state
+ type: array
+ required:
+ - state
+ - tasks
+ x-name: body
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ created:
+ format: date-time
+ readOnly: true
+ type: string
+ id:
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tasks:
+ items:
+ properties:
+ depth:
+ readOnly: true
+ type: integer
+ id:
+ readOnly: true
+ type: string
+ parents:
+ items:
+ type: string
+ readOnly: true
+ type: array
+ run:
+ readOnly: true
+ type: integer
+ slug:
+ readOnly: true
+ type: string
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ tags:
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - state
+ type: array
+ required:
+ - state
+ - tasks
+ tags:
+ - ponos
security:
- tokenAuth: []
- sessionAuth: []