diff --git a/arkindex/schema.yml b/arkindex/schema.yml
index 278ac8b9c558c5dac0ee4841390f0bff28fd47e7..a26bf7d1007156278cbebce2b1c4d8798b3bfa4d 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.7.dev2
+ version: 0.9.7-dev2
openapi: 3.0.2
paths:
/api/v1/act/{id}/:
@@ -42,8 +42,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -52,13 +54,31 @@ paths:
- name
type: object
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
type:
@@ -74,21 +94,27 @@ paths:
readOnly: true
type: array
id:
+ format: uuid
readOnly: true
type: string
metadata:
readOnly: true
type: string
name:
+ maxLength: 250
type: string
number:
+ maxLength: 30
type: string
parents:
+ items:
+ type: array
readOnly: true
type: array
required:
- name
- number
+ description: ''
security: []
tags:
- elements
@@ -118,103 +144,147 @@ paths:
application/json:
schema:
properties:
- corpus:
- properties:
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- required:
- - name
- type: object
- date_from:
- type: string
- date_to:
- type: string
- id:
- type: string
- name:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
number:
- type: string
- parent_paths:
- type: array
- total_transcriptions:
+ example: 123
type: integer
- transcriptions:
+ previous:
+ nullable: true
+ type: string
+ results:
items:
properties:
- id:
- type: string
- score:
- nullable: true
- type: number
- source:
+ corpus:
properties:
id:
+ format: uuid
type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
+ name:
+ maxLength: 250
type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
+ public:
+ type: boolean
required:
- - type
- - slug
- - revision
- - internal
+ - name
type: object
- text:
- nullable: true
+ date_from:
type: string
- type:
- enum:
- - page
- - paragraph
- - line
- - word
- - character
- zone:
- properties:
- center:
- type: array
- id:
- type: string
- image_url:
- type: string
- polygon:
- type: array
- url:
- readOnly: true
- type: string
- required:
- - polygon
- - center
- - image_url
- type: object
+ date_to:
+ type: string
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ number:
+ maxLength: 30
+ type: string
+ parent_paths:
+ items:
+ type: array
+ type: array
+ total_transcriptions:
+ type: integer
+ transcriptions:
+ items:
+ properties:
+ id:
+ format: uuid
+ type: string
+ score:
+ nullable: true
+ type: number
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ text:
+ nullable: true
+ type: string
+ type:
+ enum:
+ - page
+ - paragraph
+ - line
+ - word
+ - character
+ zone:
+ properties:
+ center:
+ items:
+ type: integer
+ type: array
+ id:
+ format: uuid
+ type: string
+ image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\\
+ d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
+ d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF\
+ 0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF\
+ 0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
+ Z"
+ type: string
+ polygon:
+ items:
+ type: array
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - polygon
+ - center
+ - image_url
+ type: object
+ required:
+ - type
+ - zone
+ - source
+ type: array
required:
- - type
- - zone
- - source
+ - name
+ - number
+ - transcriptions
+ - total_transcriptions
+ - parent_paths
+ - corpus
+ - date_from
+ - date_to
type: array
- required:
- - name
- - number
- - transcriptions
- - total_transcriptions
- - parent_paths
- - corpus
- - date_from
- - date_to
+ type: object
+ description: ''
security: []
tags:
- search
@@ -235,6 +305,8 @@ paths:
class_name:
type: string
confidence:
+ maximum: 1
+ minimum: 0
type: number
required:
- class_name
@@ -261,6 +333,8 @@ paths:
class_name:
type: string
confidence:
+ maximum: 1
+ minimum: 0
type: number
required:
- class_name
@@ -274,6 +348,7 @@ paths:
- parent
- classifier
- classifications
+ description: ''
tags:
- ml
/api/v1/classifications/:
@@ -308,6 +383,7 @@ paths:
required:
- page
- ml_class
+ description: ''
tags:
- ml
/api/v1/classifications/{id}/reject/:
@@ -337,12 +413,15 @@ paths:
nullable: true
type: number
id:
+ format: uuid
type: string
ml_class:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
@@ -350,12 +429,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -378,6 +460,7 @@ paths:
- source
- ml_class
- state
+ description: ''
tags:
- ml
/api/v1/classifications/{id}/validate/:
@@ -407,12 +490,15 @@ paths:
nullable: true
type: number
id:
+ format: uuid
type: string
ml_class:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
@@ -420,12 +506,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -448,6 +537,7 @@ paths:
- source
- ml_class
- state
+ description: ''
tags:
- ml
/api/v1/corpus/:
@@ -460,20 +550,25 @@ paths:
content:
application/json:
schema:
- properties:
- description:
- type: string
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- rights:
- readOnly: true
- type: string
- required:
- - name
+ items:
+ properties:
+ description:
+ type: string
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ public:
+ type: boolean
+ rights:
+ readOnly: true
+ type: string
+ required:
+ - name
+ type: array
+ description: ''
security: []
tags:
- corpora
@@ -489,8 +584,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -506,8 +603,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -516,6 +615,7 @@ paths:
type: string
required:
- name
+ description: ''
tags:
- corpora
/api/v1/corpus/{id}/:
@@ -533,24 +633,8 @@ paths:
schema:
type: string
responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- description:
- type: string
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- rights:
- readOnly: true
- type: string
- required:
- - name
+ '204':
+ description: ''
tags:
- corpora
get:
@@ -572,8 +656,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -582,6 +668,7 @@ paths:
type: string
required:
- name
+ description: ''
security: []
tags:
- corpora
@@ -603,8 +690,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -618,8 +707,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -628,6 +719,7 @@ paths:
type: string
required:
- name
+ description: ''
tags:
- corpora
put:
@@ -648,8 +740,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -665,8 +759,10 @@ paths:
description:
type: string
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -675,6 +771,7 @@ paths:
type: string
required:
- name
+ description: ''
tags:
- corpora
/api/v1/corpus/{id}/classes/:
@@ -695,11 +792,14 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
+ description: ''
tags:
- ml
/api/v1/corpus/{id}/pages/:
@@ -743,112 +843,141 @@ paths:
application/json:
schema:
properties:
- classifications:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
items:
properties:
- confidence:
- nullable: true
- type: number
+ classifications:
+ items:
+ properties:
+ confidence:
+ nullable: true
+ type: number
+ id:
+ format: uuid
+ type: string
+ ml_class:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 100
+ type: string
+ required:
+ - name
+ type: object
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ state:
+ enum:
+ - pending
+ - validated
+ - rejected
+ required:
+ - source
+ - ml_class
+ - state
+ type: array
+ direction:
+ enum:
+ - recto
+ - verso
+ display_name:
+ readOnly: true
+ type: string
+ folio:
+ maxLength: 250
+ type: string
id:
+ format: uuid
type: string
- ml_class:
- properties:
- id:
- type: string
- name:
- type: string
- required:
- - name
- type: object
- source:
+ image:
properties:
+ height:
+ readOnly: true
+ type: integer
id:
+ format: uuid
+ readOnly: true
type: string
- internal:
- type: boolean
- revision:
+ path:
+ readOnly: true
type: string
- slug:
+ s3_url:
+ readOnly: true
type: string
- type:
+ status:
enum:
- - classifier
- - recognizer
- - ner
- - dla
+ - checked
+ - unchecked
+ - error
+ url:
+ readOnly: true
+ type: string
+ width:
+ readOnly: true
+ type: integer
required:
- - type
- - slug
- - revision
- - internal
+ - status
type: object
- state:
+ nb:
+ maximum: 2147483647
+ minimum: 0
+ nullable: true
+ type: integer
+ page_type:
enum:
- - pending
- - validated
- - rejected
+ - page
+ - summary
+ - garde
+ - contregarde
+ - contreplat
+ - plat
+ - copy
required:
- - source
- - ml_class
- - state
+ - page_type
+ - direction
+ - image
+ - classifications
+ - folio
type: array
- direction:
- enum:
- - recto
- - verso
- display_name:
- readOnly: true
- type: string
- folio:
- type: string
- id:
- type: string
- image:
- properties:
- height:
- readOnly: true
- type: integer
- id:
- readOnly: true
- type: string
- path:
- readOnly: true
- type: string
- s3_url:
- readOnly: true
- type: string
- status:
- enum:
- - checked
- - unchecked
- - error
- url:
- readOnly: true
- type: string
- width:
- readOnly: true
- type: integer
- required:
- - status
- type: object
- nb:
- nullable: true
- type: integer
- page_type:
- enum:
- - page
- - summary
- - garde
- - contregarde
- - contreplat
- - plat
- - copy
- required:
- - page_type
- - direction
- - image
- - classifications
- - folio
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -881,36 +1010,56 @@ paths:
application/json:
schema:
properties:
- child_name:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- child_type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- id:
- readOnly: true
+ number:
+ example: 123
type: integer
- parent_name:
+ previous:
+ nullable: true
type: string
- parent_type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- required:
- - parent_name
- - child_name
- - parent_type
- - child_type
+ results:
+ items:
+ properties:
+ child_name:
+ maxLength: 250
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ maxLength: 250
+ type: string
+ parent_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - parent_name
+ - child_name
+ - parent_type
+ - child_type
+ type: array
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -930,6 +1079,7 @@ paths:
schema:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -941,6 +1091,7 @@ paths:
- number
- date
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -964,6 +1115,7 @@ paths:
schema:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -978,6 +1130,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -993,6 +1146,7 @@ paths:
- child_name
- parent_type
- child_type
+ description: ''
'400':
content:
application/json:
@@ -1036,8 +1190,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -1046,16 +1202,32 @@ paths:
- name
type: object
id:
+ format: uuid
type: string
metadata:
readOnly: true
type: string
name:
+ maxLength: 250
type: string
thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
type:
@@ -1068,6 +1240,7 @@ paths:
readOnly: true
required:
- name
+ description: ''
security: []
tags:
- elements
@@ -1087,8 +1260,10 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
x-name: body
responses:
@@ -1100,8 +1275,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -1110,16 +1287,32 @@ paths:
- name
type: object
id:
+ format: uuid
type: string
metadata:
readOnly: true
type: string
name:
+ maxLength: 250
type: string
thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
type:
@@ -1132,6 +1325,7 @@ paths:
readOnly: true
required:
- name
+ description: ''
tags:
- elements
put:
@@ -1150,8 +1344,10 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
required:
- name
@@ -1165,8 +1361,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -1175,16 +1373,32 @@ paths:
- name
type: object
id:
+ format: uuid
type: string
metadata:
readOnly: true
type: string
name:
+ maxLength: 250
type: string
thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
type:
@@ -1197,6 +1411,7 @@ paths:
readOnly: true
required:
- name
+ description: ''
tags:
- elements
/api/v1/element/{id}/entities/:
@@ -1217,6 +1432,7 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
metadata:
items:
@@ -1225,9 +1441,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -1237,6 +1457,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -1250,9 +1471,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -1262,6 +1487,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -1271,34 +1497,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -1313,15 +1518,17 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
revision:
properties:
author:
+ maxLength: 50
type: string
commit_url:
readOnly: true
@@ -1330,12 +1537,15 @@ paths:
format: date-time
type: string
hash:
+ maxLength: 50
type: string
id:
+ format: uuid
type: string
message:
type: string
ref:
+ maxLength: 50
type: string
repo_id:
readOnly: true
@@ -1365,6 +1575,7 @@ paths:
- entity
type: array
name:
+ maxLength: 250
type: string
transcriptions:
items:
@@ -1375,9 +1586,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -1387,6 +1602,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -1396,34 +1612,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -1438,11 +1633,12 @@ paths:
required:
- name
- type
- - source
type: object
length:
+ minimum: 0
type: integer
offset:
+ minimum: 0
type: integer
required:
- entity
@@ -1461,6 +1657,7 @@ paths:
- name
- transcriptions
- metadata
+ description: ''
tags:
- entities
/api/v1/element/{id}/history/:
@@ -1492,48 +1689,71 @@ paths:
application/json:
schema:
properties:
- date:
- format: date-time
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- id:
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
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:
- - A
- - M
- - D
- required:
- - type
- - date
- - revision
+ results:
+ items:
+ properties:
+ date:
+ format: date-time
+ type: string
+ id:
+ format: uuid
+ type: string
+ revision:
+ properties:
+ author:
+ maxLength: 50
+ type: string
+ commit_url:
+ readOnly: true
+ type: string
+ date:
+ format: date-time
+ type: string
+ hash:
+ maxLength: 50
+ type: string
+ id:
+ format: uuid
+ type: string
+ message:
+ type: string
+ ref:
+ maxLength: 50
+ type: string
+ repo_id:
+ readOnly: true
+ type: string
+ required:
+ - date
+ - hash
+ - ref
+ - message
+ - author
+ type: object
+ type:
+ enum:
+ - A
+ - M
+ - D
+ required:
+ - type
+ - date
+ - revision
+ type: array
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -1566,141 +1786,174 @@ paths:
application/json:
schema:
properties:
- child:
- properties:
- dates:
- items:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ child:
properties:
- day:
+ dates:
+ items:
+ properties:
+ day:
+ maximum: 31
+ minimum: 1
+ nullable: true
+ type: integer
+ month:
+ maximum: 12
+ minimum: 1
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ minimum: 0
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
nullable: true
- type: integer
- month:
+ type: array
+ id:
+ format: uuid
+ type: string
+ metas:
nullable: true
- type: integer
+ type: object
+ name:
+ type: string
type:
enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
- required:
- - type
- - year
- - month
- - day
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- 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:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ type: object
+ id:
+ format: uuid
+ type: string
+ parent:
properties:
- day:
+ dates:
+ items:
+ properties:
+ day:
+ maximum: 31
+ minimum: 1
+ nullable: true
+ type: integer
+ month:
+ maximum: 12
+ minimum: 1
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ minimum: 0
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
nullable: true
- type: integer
- month:
+ type: array
+ id:
+ format: uuid
+ type: string
+ metas:
nullable: true
- type: integer
+ type: object
+ name:
+ type: string
type:
enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
required:
+ - name
- type
- - year
- - month
- - day
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- 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: object
+ role:
+ properties:
+ child_name:
+ maxLength: 250
+ type: string
+ child_type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ id:
+ readOnly: true
+ type: integer
+ parent_name:
+ maxLength: 250
+ 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: object
+ description: ''
tags:
- entities
/api/v1/element/{id}/region/:
@@ -1724,8 +1977,12 @@ paths:
class_name:
type: string
confidence:
+ maximum: 1
+ minimum: 0
type: number
polygon:
+ items:
+ type: array
type: array
required:
- class_name
@@ -1744,17 +2001,23 @@ paths:
class_name:
type: string
confidence:
+ maximum: 1
+ minimum: 0
type: number
id:
+ format: uuid
readOnly: true
type: string
polygon:
+ items:
+ type: array
type: array
required:
- class_name
- confidence
- polygon
- analyser
+ description: ''
tags:
- elements
/api/v1/element/{id}/regions/:
@@ -1786,161 +2049,233 @@ paths:
application/json:
schema:
properties:
- confidence:
+ count:
+ example: 123
+ type: integer
+ next:
nullable: true
- type: number
- id:
- type: string
- ml_class:
- properties:
- id:
- type: string
- name:
- type: string
- required:
- - name
- type: object
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- zone:
- properties:
- center:
- type: array
- id:
- type: string
- image_url:
- type: string
- polygon:
- type: array
- url:
- readOnly: true
- type: string
- required:
- - polygon
- - center
- - image_url
- type: object
- required:
- - source
- - ml_class
- - zone
- security: []
- tags:
- - elements
- /api/v1/element/{id}/transcriptions/:
- get:
- description: List all transcriptions for an element, filtered by type
- operationId: ListTranscriptions
- parameters:
- - description: Element id
- 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: Transcription type filter
- in: query
- name: type
- required: false
- schema:
- enum:
- - page
- - paragraph
- - line
- - word
- - character
- type: string
- responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- id:
type: string
- score:
+ number:
+ example: 123
+ type: integer
+ previous:
nullable: true
- type: number
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- text:
+ type: string
+ results:
+ items:
+ properties:
+ confidence:
+ nullable: true
+ type: number
+ id:
+ format: uuid
+ type: string
+ ml_class:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 100
+ type: string
+ required:
+ - name
+ type: object
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ zone:
+ properties:
+ center:
+ items:
+ type: integer
+ type: array
+ id:
+ format: uuid
+ type: string
+ image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ type: string
+ polygon:
+ items:
+ type: array
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - polygon
+ - center
+ - image_url
+ type: object
+ required:
+ - source
+ - ml_class
+ - zone
+ type: array
+ type: object
+ description: ''
+ security: []
+ tags:
+ - elements
+ /api/v1/element/{id}/transcriptions/:
+ get:
+ description: List all transcriptions for an element, filtered by type
+ operationId: ListTranscriptions
+ parameters:
+ - description: Element id
+ 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: Transcription type filter
+ in: query
+ name: type
+ required: false
+ schema:
+ enum:
+ - page
+ - paragraph
+ - line
+ - word
+ - character
+ type: string
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ count:
+ example: 123
+ type: integer
+ next:
nullable: true
type: string
- type:
- enum:
- - page
- - paragraph
- - line
- - word
- - character
- zone:
- properties:
- center:
- type: array
- id:
- type: string
- image_url:
- type: string
- polygon:
- type: array
- url:
- readOnly: true
- type: string
- required:
- - polygon
- - center
- - image_url
- type: object
- required:
- - type
- - zone
- - source
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ id:
+ format: uuid
+ type: string
+ score:
+ nullable: true
+ type: number
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ text:
+ nullable: true
+ type: string
+ type:
+ enum:
+ - page
+ - paragraph
+ - line
+ - word
+ - character
+ zone:
+ properties:
+ center:
+ items:
+ type: integer
+ type: array
+ id:
+ format: uuid
+ type: string
+ image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ type: string
+ polygon:
+ items:
+ type: array
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - polygon
+ - center
+ - image_url
+ type: object
+ required:
+ - type
+ - zone
+ - source
+ type: array
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -2116,38 +2451,76 @@ paths:
application/json:
schema:
properties:
- corpus:
- properties:
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- readOnly: true
- required:
- - name
- type: object
- id:
- type: string
- name:
- type: string
- thumbnail_put_url:
- readOnly: true
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- thumbnail_url:
- readOnly: true
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- type:
- enum:
- - volume
- - register
- - act
- - page
- - surface
- readOnly: true
- required:
- - name
+ results:
+ items:
+ properties:
+ corpus:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ public:
+ type: boolean
+ readOnly: true
+ required:
+ - name
+ type: object
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ type:
+ enum:
+ - volume
+ - register
+ - act
+ - page
+ - surface
+ readOnly: true
+ required:
+ - name
+ type: array
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -2164,12 +2537,14 @@ paths:
corpus:
type: string
id:
+ format: uuid
type: string
image:
type: string
metadata:
type: object
name:
+ maxLength: 250
type: string
parent:
type: string
@@ -2194,12 +2569,14 @@ paths:
corpus:
type: string
id:
+ format: uuid
type: string
image:
type: string
metadata:
type: object
name:
+ maxLength: 250
type: string
parent:
type: string
@@ -2214,6 +2591,7 @@ paths:
- type
- name
- corpus
+ description: ''
tags:
- elements
/api/v1/elements/{id}/:
@@ -2227,18 +2605,6 @@ 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:
@@ -2248,8 +2614,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -2258,13 +2626,29 @@ paths:
- name
type: object
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
type:
@@ -2277,6 +2661,7 @@ paths:
readOnly: true
required:
- name
+ description: ''
security: []
tags:
- elements
@@ -2309,31 +2694,53 @@ paths:
application/json:
schema:
properties:
- element:
- properties:
- id:
- type: string
- name:
- type: string
- type:
- enum:
- - volume
- - register
- - act
- - page
- - surface
- required:
- - type
- - name
- type: object
- parents:
- type: array
- position:
+ count:
+ example: 123
type: integer
- required:
- - position
- - element
- - parents
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ element:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ type:
+ enum:
+ - volume
+ - register
+ - act
+ - page
+ - surface
+ required:
+ - type
+ - name
+ type: object
+ parents:
+ items:
+ type: object
+ type: array
+ position:
+ type: integer
+ required:
+ - position
+ - element
+ - parents
+ type: array
+ type: object
+ description: ''
tags:
- elements
/api/v1/elements/{id}/pages/:
@@ -2365,112 +2772,141 @@ paths:
application/json:
schema:
properties:
- classifications:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
items:
properties:
- confidence:
- nullable: true
- type: number
+ classifications:
+ items:
+ properties:
+ confidence:
+ nullable: true
+ type: number
+ id:
+ format: uuid
+ type: string
+ ml_class:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 100
+ type: string
+ required:
+ - name
+ type: object
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ state:
+ enum:
+ - pending
+ - validated
+ - rejected
+ required:
+ - source
+ - ml_class
+ - state
+ type: array
+ direction:
+ enum:
+ - recto
+ - verso
+ display_name:
+ readOnly: true
+ type: string
+ folio:
+ maxLength: 250
+ type: string
id:
+ format: uuid
type: string
- ml_class:
- properties:
- id:
- type: string
- name:
- type: string
- required:
- - name
- type: object
- source:
+ image:
properties:
+ height:
+ readOnly: true
+ type: integer
id:
+ format: uuid
+ readOnly: true
type: string
- internal:
- type: boolean
- revision:
+ path:
+ readOnly: true
type: string
- slug:
+ s3_url:
+ readOnly: true
type: string
- type:
+ status:
enum:
- - classifier
- - recognizer
- - ner
- - dla
+ - checked
+ - unchecked
+ - error
+ url:
+ readOnly: true
+ type: string
+ width:
+ readOnly: true
+ type: integer
required:
- - type
- - slug
- - revision
- - internal
+ - status
type: object
- state:
+ nb:
+ maximum: 2147483647
+ minimum: 0
+ nullable: true
+ type: integer
+ page_type:
enum:
- - pending
- - validated
- - rejected
+ - page
+ - summary
+ - garde
+ - contregarde
+ - contreplat
+ - plat
+ - copy
required:
- - source
- - ml_class
- - state
+ - page_type
+ - direction
+ - image
+ - classifications
+ - folio
type: array
- direction:
- enum:
- - recto
- - verso
- display_name:
- readOnly: true
- type: string
- folio:
- type: string
- id:
- type: string
- image:
- properties:
- height:
- readOnly: true
- type: integer
- id:
- readOnly: true
- type: string
- path:
- readOnly: true
- type: string
- s3_url:
- readOnly: true
- type: string
- status:
- enum:
- - checked
- - unchecked
- - error
- url:
- readOnly: true
- type: string
- width:
- readOnly: true
- type: integer
- required:
- - status
- type: object
- nb:
- nullable: true
- type: integer
- page_type:
- enum:
- - page
- - summary
- - garde
- - contregarde
- - contreplat
- - plat
- - copy
- required:
- - page_type
- - direction
- - image
- - classifications
- - folio
+ type: object
+ description: ''
security: []
tags:
- elements
@@ -2480,602 +2916,11 @@ paths:
operationId: ListElementSurfaces
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
- 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
- security: []
- tags:
- - elements
- /api/v1/entity/:
- post:
- description: Create a new entity
- operationId: CreateEntity
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- 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
- nullable: true
- type: array
- metas:
- type: string
- name:
- type: string
- ner:
- type: string
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - corpus
- - ner
- 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
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - source
- 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
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - source
- 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
- readOnly: true
- 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
- nullable: true
- type: array
- id:
- readOnly: true
- type: string
- metas:
- type: string
- name:
- type: string
- ner:
- 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
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - source
- 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
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - source
- 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
- readOnly: true
- type: array
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - corpus
- - ner
- tags:
- - entities
- /api/v1/entity/link/:
- post:
- description: Create a new link between two entities with a role
- operationId: CreateEntityLink
- parameters: []
- requestBody:
- content:
- application/json:
- schema:
- properties:
- child:
- type: string
- id:
- type: string
- parent:
- type: string
- role:
- type: string
- required:
- - parent
- - child
- - role
- x-name: body
- responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- child:
- type: string
- id:
- type: string
- parent:
- type: string
- role:
- type: string
- required:
- - parent
- - child
- - role
- tags:
- - entities
- /api/v1/entity/search/:
- get:
- description: Get a list of entities
- operationId: SearchEntities
- parameters:
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
- description: A page number within the paginated result set.
in: query
name: page
@@ -3094,38 +2939,140 @@ paths:
application/json:
schema:
properties:
- id:
- type: string
- metas:
+ count:
+ example: 123
+ type: integer
+ next:
nullable: true
type: string
- name:
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- required:
- - name
- - type
+ results:
+ items:
+ properties:
+ corpus:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ public:
+ type: boolean
+ readOnly: true
+ required:
+ - name
+ type: object
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ type:
+ enum:
+ - volume
+ - register
+ - act
+ - page
+ - surface
+ readOnly: true
+ required:
+ - name
+ type: array
+ type: object
+ description: ''
+ security: []
tags:
- - search
- /api/v1/entity/{id}/:
- delete:
- description: Delete an entity
- operationId: DestroyEntity
- parameters:
- - description: ''
- in: path
- name: id
- required: true
- schema:
- type: string
+ - elements
+ /api/v1/entity/:
+ post:
+ description: Create a new entity
+ operationId: CreateEntity
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ corpus:
+ type: string
+ dates:
+ items:
+ properties:
+ day:
+ maximum: 31
+ minimum: 1
+ nullable: true
+ type: integer
+ month:
+ maximum: 12
+ minimum: 1
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ minimum: 0
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
+ nullable: true
+ type: array
+ metas:
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
+ required:
+ - name
+ - type
+ - corpus
+ x-name: body
responses:
'200':
content:
@@ -3141,9 +3088,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3153,6 +3104,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3162,34 +3114,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3204,9 +3135,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -3214,9 +3145,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3226,6 +3161,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3235,34 +3171,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3277,11 +3192,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -3296,6 +3211,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -3316,25 +3232,21 @@ paths:
- parent
- child
- role
+ readOnly: true
type: array
corpus:
- properties:
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- required:
- - name
- type: object
+ type: string
dates:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3344,6 +3256,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3353,10 +3266,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
+ readOnly: true
type: string
metas:
- nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -3368,9 +3282,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3380,6 +3298,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3389,34 +3308,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3431,9 +3329,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -3441,9 +3339,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3453,43 +3355,23 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- - type
- - year
- - month
- - day
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
+ - type
+ - year
+ - month
+ - day
+ nullable: true
+ type: array
+ id:
+ format: uuid
+ type: string
+ metas:
+ nullable: true
type: object
+ name:
+ type: string
type:
enum:
- person
@@ -3504,11 +3386,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -3523,6 +3405,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -3543,29 +3426,8 @@ paths:
- parent
- child
- role
+ readOnly: true
type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3580,10 +3442,133 @@ paths:
required:
- name
- type
- - source
- corpus
- - children
- - parents
+ description: ''
+ tags:
+ - entities
+ /api/v1/entity/link/:
+ post:
+ description: Create a new link between two entities with a role
+ operationId: CreateEntityLink
+ parameters: []
+ requestBody:
+ content:
+ application/json:
+ schema:
+ properties:
+ child:
+ type: string
+ id:
+ format: uuid
+ type: string
+ parent:
+ type: string
+ role:
+ type: string
+ required:
+ - parent
+ - child
+ - role
+ x-name: body
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ child:
+ type: string
+ id:
+ format: uuid
+ type: string
+ parent:
+ type: string
+ role:
+ type: string
+ required:
+ - parent
+ - child
+ - role
+ description: ''
+ tags:
+ - entities
+ /api/v1/entity/search/:
+ get:
+ description: Get a list of entities
+ operationId: SearchEntities
+ parameters:
+ - 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:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ id:
+ format: uuid
+ type: string
+ metas:
+ nullable: true
+ type: object
+ name:
+ type: string
+ type:
+ enum:
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ required:
+ - name
+ - type
+ type: array
+ type: object
+ description: ''
+ tags:
+ - search
+ /api/v1/entity/{id}/:
+ delete:
+ description: Delete an entity
+ operationId: DestroyEntity
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: ''
tags:
- entities
get:
@@ -3611,9 +3596,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3623,6 +3612,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3632,34 +3622,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3674,9 +3643,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -3684,9 +3653,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3696,6 +3669,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3705,34 +3679,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3747,11 +3700,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -3766,6 +3719,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -3790,8 +3744,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -3802,9 +3758,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3814,6 +3774,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3823,10 +3784,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -3838,9 +3800,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3850,6 +3816,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -3859,34 +3826,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -3901,9 +3847,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -3911,9 +3857,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -3923,43 +3873,23 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- - type
- - year
- - month
- - day
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
+ - type
+ - year
+ - month
+ - day
+ nullable: true
+ type: array
+ id:
+ format: uuid
+ type: string
+ metas:
+ nullable: true
type: object
+ name:
+ type: string
type:
enum:
- person
@@ -3974,11 +3904,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -3993,6 +3923,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -4014,28 +3945,6 @@ paths:
- child
- role
type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4050,10 +3959,10 @@ paths:
required:
- name
- type
- - source
- corpus
- children
- parents
+ description: ''
security: []
tags:
- entities
@@ -4081,9 +3990,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4093,6 +4006,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4102,34 +4016,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4144,9 +4037,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -4154,9 +4047,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4166,6 +4063,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4175,34 +4073,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4217,11 +4094,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -4236,6 +4113,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -4260,8 +4138,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -4272,9 +4152,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4284,6 +4168,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4293,10 +4178,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -4308,9 +4194,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4320,6 +4210,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4329,34 +4220,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4371,9 +4241,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -4381,9 +4251,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4393,6 +4267,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4402,34 +4277,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4444,11 +4298,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -4463,6 +4317,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -4484,28 +4339,6 @@ paths:
- child
- role
type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4533,9 +4366,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4545,6 +4382,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4554,34 +4392,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4596,9 +4413,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -4606,9 +4423,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4618,6 +4439,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4627,34 +4449,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4669,11 +4470,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -4688,6 +4489,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -4712,8 +4514,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -4724,9 +4528,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4736,6 +4544,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4745,10 +4554,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -4760,9 +4570,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4772,6 +4586,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4781,34 +4596,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4823,9 +4617,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -4833,9 +4627,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -4845,6 +4643,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -4854,34 +4653,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -4896,11 +4674,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -4915,6 +4693,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -4932,32 +4711,10 @@ paths:
- child_type
type: object
required:
- - parent
- - child
- - role
- type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
+ - parent
+ - child
+ - role
+ type: array
type:
enum:
- person
@@ -4972,10 +4729,10 @@ paths:
required:
- name
- type
- - source
- corpus
- children
- parents
+ description: ''
tags:
- entities
put:
@@ -5002,9 +4759,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5014,6 +4775,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5023,34 +4785,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5065,9 +4806,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -5075,9 +4816,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5087,6 +4832,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5096,34 +4842,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5138,11 +4863,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -5157,6 +4882,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -5181,8 +4907,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -5193,9 +4921,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5205,6 +4937,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5214,10 +4947,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -5229,9 +4963,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5241,6 +4979,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5250,34 +4989,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5292,9 +5010,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -5302,9 +5020,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5314,6 +5036,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5323,34 +5046,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5365,11 +5067,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -5384,6 +5086,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -5405,28 +5108,6 @@ paths:
- child
- role
type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5441,7 +5122,6 @@ paths:
required:
- name
- type
- - source
- corpus
- children
- parents
@@ -5461,9 +5141,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5473,6 +5157,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5482,34 +5167,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5524,9 +5188,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -5534,9 +5198,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5546,6 +5214,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5555,34 +5224,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5597,11 +5245,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -5616,6 +5264,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -5640,8 +5289,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -5652,9 +5303,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5664,6 +5319,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5673,10 +5329,11 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
parents:
@@ -5688,9 +5345,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5700,6 +5361,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5709,34 +5371,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5751,9 +5392,9 @@ paths:
required:
- name
- type
- - source
type: object
id:
+ format: uuid
type: string
parent:
properties:
@@ -5761,9 +5402,13 @@ paths:
items:
properties:
day:
+ maximum: 31
+ minimum: 1
nullable: true
type: integer
month:
+ maximum: 12
+ minimum: 1
nullable: true
type: integer
type:
@@ -5773,6 +5418,7 @@ paths:
- upper
- unknown
year:
+ minimum: 0
type: integer
required:
- type
@@ -5782,34 +5428,13 @@ paths:
nullable: true
type: array
id:
+ format: uuid
type: string
metas:
nullable: true
- type: string
+ type: object
name:
type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5824,11 +5449,11 @@ paths:
required:
- name
- type
- - source
type: object
role:
properties:
child_name:
+ maxLength: 250
type: string
child_type:
enum:
@@ -5843,6 +5468,7 @@ paths:
readOnly: true
type: integer
parent_name:
+ maxLength: 250
type: string
parent_type:
enum:
@@ -5864,28 +5490,6 @@ paths:
- child
- role
type: array
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
type:
enum:
- person
@@ -5900,10 +5504,10 @@ paths:
required:
- name
- type
- - source
- corpus
- children
- parents
+ description: ''
tags:
- entities
/api/v1/entity/{id}/elements/:
@@ -5935,38 +5539,79 @@ paths:
application/json:
schema:
properties:
- corpus:
- properties:
- id:
- type: string
- name:
- type: string
- public:
- type: boolean
- readOnly: true
- required:
- - name
- type: object
- id:
- type: string
- 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
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ corpus:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ public:
+ type: boolean
+ readOnly: true
+ required:
+ - name
+ type: object
+ id:
+ format: uuid
+ type: string
+ metadata:
+ readOnly: true
+ type: string
+ name:
+ maxLength: 250
+ type: string
+ thumbnail_put_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ thumbnail_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ type:
+ enum:
+ - volume
+ - register
+ - act
+ - page
+ - surface
+ readOnly: true
+ required:
+ - name
+ type: array
+ type: object
+ description: ''
security: []
tags:
- entities
@@ -5987,8 +5632,13 @@ paths:
nullable: true
type: string
hash:
+ maxLength: 32
+ minLength: 32
+ pattern: '[0-9A-Fa-f]{32}'
type: string
height:
+ maximum: 2147483647
+ minimum: 0
type: integer
path:
type: string
@@ -5996,6 +5646,8 @@ paths:
type: integer
writeOnly: true
width:
+ maximum: 2147483647
+ minimum: 0
type: integer
required:
- hash
@@ -6010,10 +5662,16 @@ paths:
nullable: true
type: string
hash:
+ maxLength: 32
+ minLength: 32
+ pattern: '[0-9A-Fa-f]{32}'
type: string
height:
+ maximum: 2147483647
+ minimum: 0
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6034,9 +5692,12 @@ paths:
readOnly: true
type: string
width:
+ maximum: 2147483647
+ minimum: 0
type: integer
required:
- hash
+ description: ''
'400':
content:
application/json:
@@ -6094,6 +5755,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6115,6 +5777,7 @@ paths:
type: integer
required:
- status
+ description: ''
tags:
- images
patch:
@@ -6148,6 +5811,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6169,6 +5833,7 @@ paths:
type: integer
required:
- status
+ description: ''
tags:
- images
put:
@@ -6204,6 +5869,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6225,6 +5891,7 @@ paths:
type: integer
required:
- status
+ description: ''
tags:
- images
/api/v1/imports/:
@@ -6250,31 +5917,50 @@ paths:
application/json:
schema:
properties:
- corpus:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- id:
- readOnly: true
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- mode:
- enum:
- - images
- - pdf
- - repository
- - elements
- state:
- enum:
- - unscheduled
- - pending
- - running
- - completed
- - failed
- - error
- - stopping
- - stopped
- required:
- - state
- - mode
- - corpus
+ results:
+ items:
+ properties:
+ corpus:
+ type: string
+ id:
+ format: uuid
+ readOnly: true
+ type: string
+ mode:
+ enum:
+ - images
+ - pdf
+ - repository
+ - elements
+ state:
+ enum:
+ - unscheduled
+ - pending
+ - running
+ - completed
+ - failed
+ - error
+ - stopping
+ - stopped
+ required:
+ - state
+ - mode
+ - corpus
+ type: array
+ type: object
+ description: ''
tags:
- imports
/api/v1/imports/demo/{id}/:
@@ -6337,6 +6023,7 @@ paths:
type: string
type: array
id:
+ format: uuid
readOnly: true
type: string
mode:
@@ -6350,6 +6037,7 @@ paths:
revision:
properties:
author:
+ maxLength: 50
type: string
commit_url:
readOnly: true
@@ -6358,12 +6046,15 @@ paths:
format: date-time
type: string
hash:
+ maxLength: 50
type: string
id:
+ format: uuid
type: string
message:
type: string
ref:
+ maxLength: 50
type: string
repo_id:
readOnly: true
@@ -6395,6 +6086,7 @@ paths:
- corpus
- payload
- files
+ description: ''
security: []
tags:
- imports
@@ -6410,66 +6102,8 @@ paths:
schema:
type: string
responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- content_type:
- readOnly: true
- type: string
- hash:
- readOnly: true
- type: string
- id:
- readOnly: true
- type: string
- images:
- items:
- properties:
- height:
- readOnly: true
- type: integer
- id:
- readOnly: true
- type: string
- path:
- readOnly: true
- type: string
- s3_url:
- readOnly: true
- type: string
- status:
- enum:
- - checked
- - unchecked
- - error
- url:
- readOnly: true
- type: string
- width:
- readOnly: true
- type: integer
- required:
- - status
- readOnly: true
- type: array
- name:
- readOnly: true
- type: string
- s3_url:
- readOnly: true
- type: string
- size:
- readOnly: true
- type: integer
- status:
- enum:
- - checked
- - unchecked
- - error
- required:
- - status
+ '204':
+ description: ''
tags:
- files
get:
@@ -6495,6 +6129,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
readOnly: true
type: string
images:
@@ -6504,6 +6139,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6534,6 +6170,7 @@ paths:
readOnly: true
type: string
size:
+ description: file size in bytes
readOnly: true
type: integer
status:
@@ -6543,6 +6180,7 @@ paths:
- error
required:
- status
+ description: ''
tags:
- files
patch:
@@ -6579,6 +6217,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
readOnly: true
type: string
images:
@@ -6588,6 +6227,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6618,6 +6258,7 @@ paths:
readOnly: true
type: string
size:
+ description: file size in bytes
readOnly: true
type: integer
status:
@@ -6627,6 +6268,7 @@ paths:
- error
required:
- status
+ description: ''
tags:
- files
put:
@@ -6665,6 +6307,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
readOnly: true
type: string
images:
@@ -6674,6 +6317,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6704,6 +6348,7 @@ paths:
readOnly: true
type: string
size:
+ description: file size in bytes
readOnly: true
type: integer
status:
@@ -6713,6 +6358,7 @@ paths:
- error
required:
- status
+ description: ''
tags:
- files
/api/v1/imports/files/create/:
@@ -6729,10 +6375,16 @@ paths:
corpus:
type: string
hash:
+ maxLength: 32
+ pattern: '[0-9a-f]{32}'
type: string
name:
+ maxLength: 100
type: string
size:
+ description: file size in bytes
+ maximum: 2147483647
+ minimum: 0
type: integer
required:
- name
@@ -6749,11 +6401,15 @@ paths:
corpus:
type: string
hash:
+ maxLength: 32
+ pattern: '[0-9a-f]{32}'
type: string
id:
+ format: uuid
readOnly: true
type: string
name:
+ maxLength: 100
type: string
s3_put_url:
readOnly: true
@@ -6762,6 +6418,9 @@ paths:
readOnly: true
type: string
size:
+ description: file size in bytes
+ maximum: 2147483647
+ minimum: 0
type: integer
status:
enum:
@@ -6774,6 +6433,7 @@ paths:
- hash
- size
- corpus
+ description: ''
'400':
content:
application/json:
@@ -6845,18 +6505,6 @@ 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:
@@ -6870,6 +6518,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
readOnly: true
type: string
images:
@@ -6879,6 +6528,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -6909,6 +6559,7 @@ paths:
readOnly: true
type: string
size:
+ description: file size in bytes
readOnly: true
type: integer
status:
@@ -6918,6 +6569,7 @@ paths:
- error
required:
- status
+ description: ''
tags:
- files
/api/v1/imports/fromfiles/:
@@ -6938,9 +6590,11 @@ paths:
items:
properties:
parents:
+ default: []
items:
properties:
slug:
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
type:
enum:
@@ -6953,6 +6607,7 @@ paths:
- slug
type: array
slug:
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
type:
enum:
@@ -6966,19 +6621,23 @@ paths:
nullable: true
type: array
mode:
+ default: images
enum:
- images
- pdf
- repository
- elements
pdf_engine:
+ default: convert
enum:
- convert
- poppler
volume_id:
+ format: uuid
nullable: true
type: string
volume_name:
+ maxLength: 250
nullable: true
type: string
required:
@@ -6998,9 +6657,11 @@ paths:
items:
properties:
parents:
+ default: []
items:
properties:
slug:
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
type:
enum:
@@ -7013,6 +6674,7 @@ paths:
- slug
type: array
slug:
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
type:
enum:
@@ -7026,23 +6688,28 @@ paths:
nullable: true
type: array
mode:
+ default: images
enum:
- images
- pdf
- repository
- elements
pdf_engine:
+ default: convert
enum:
- convert
- poppler
volume_id:
+ format: uuid
nullable: true
type: string
volume_name:
+ maxLength: 250
nullable: true
type: string
required:
- files
+ description: ''
tags:
- files
/api/v1/imports/hook/{id}/:
@@ -7062,6 +6729,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- repos
@@ -7075,24 +6743,28 @@ paths:
content:
application/json:
schema:
- properties:
- name:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- version:
- type: string
- required:
- - type
- - slug
- - name
- - version
+ items:
+ properties:
+ name:
+ type: string
+ slug:
+ pattern: ^[-a-zA-Z0-9_]+$
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ version:
+ type: string
+ required:
+ - type
+ - slug
+ - name
+ - version
+ type: array
+ description: ''
security: []
tags:
- ml
@@ -7119,19 +6791,46 @@ paths:
application/json:
schema:
properties:
- corpus:
- type: string
- enabled:
- readOnly: true
- type: string
- id:
- readOnly: true
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- url:
- readOnly: true
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- required:
- - corpus
+ results:
+ items:
+ properties:
+ corpus:
+ type: string
+ enabled:
+ readOnly: true
+ type: string
+ id:
+ format: uuid
+ readOnly: true
+ type: string
+ url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ readOnly: true
+ type: string
+ required:
+ - corpus
+ type: array
+ type: object
+ description: ''
tags:
- repos
/api/v1/imports/repos/search/{id}/:
@@ -7156,12 +6855,15 @@ paths:
schema:
properties:
corpus:
+ format: uuid
type: string
id:
+ minimum: 0
type: integer
required:
- id
- corpus
+ description: ''
tags:
- repos
post:
@@ -7181,8 +6883,10 @@ paths:
schema:
properties:
corpus:
+ format: uuid
type: string
id:
+ minimum: 0
type: integer
required:
- id
@@ -7195,44 +6899,31 @@ paths:
schema:
properties:
corpus:
+ format: uuid
type: string
id:
+ minimum: 0
type: integer
required:
- id
- corpus
+ description: ''
tags:
- repos
/api/v1/imports/repos/{id}/:
delete:
description: Delete a repository
- operationId: DestroyRepository
- parameters:
- - description: ''
- in: path
- name: id
- required: true
- schema:
- type: string
- responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- corpus:
- type: string
- enabled:
- readOnly: true
- type: string
- id:
- readOnly: true
- type: string
- url:
- readOnly: true
- type: string
- required:
- - corpus
+ operationId: DestroyRepository
+ parameters:
+ - description: ''
+ in: path
+ name: id
+ required: true
+ schema:
+ type: string
+ responses:
+ '204':
+ description: ''
tags:
- repos
get:
@@ -7257,13 +6948,22 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
readOnly: true
type: string
url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
readOnly: true
type: string
required:
- corpus
+ description: ''
tags:
- repos
/api/v1/imports/repos/{id}/start/:
@@ -7284,9 +6984,11 @@ paths:
schema:
properties:
import_id:
+ format: uuid
type: string
required:
- import_id
+ description: ''
tags:
- repos
/api/v1/imports/upload/{id}/:
@@ -7305,6 +7007,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
'400':
content:
application/json:
@@ -7354,76 +7057,8 @@ paths:
schema:
type: string
responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- corpus:
- type: string
- files:
- items:
- type: string
- type: array
- id:
- readOnly: true
- type: string
- mode:
- enum:
- - images
- - pdf
- - repository
- - elements
- payload:
- type: object
- 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
- readOnly: true
- required:
- - date
- - hash
- - ref
- - message
- - author
- type: object
- state:
- enum:
- - unscheduled
- - pending
- - running
- - completed
- - failed
- - error
- - stopping
- - stopped
- workflow:
- readOnly: true
- type: string
- required:
- - state
- - mode
- - corpus
- - payload
- - files
+ '204':
+ description: ''
tags:
- imports
get:
@@ -7449,6 +7084,7 @@ paths:
type: string
type: array
id:
+ format: uuid
readOnly: true
type: string
mode:
@@ -7462,6 +7098,7 @@ paths:
revision:
properties:
author:
+ maxLength: 50
type: string
commit_url:
readOnly: true
@@ -7470,12 +7107,15 @@ paths:
format: date-time
type: string
hash:
+ maxLength: 50
type: string
id:
+ format: uuid
type: string
message:
type: string
ref:
+ maxLength: 50
type: string
repo_id:
readOnly: true
@@ -7507,6 +7147,7 @@ paths:
- corpus
- payload
- files
+ description: ''
tags:
- imports
/api/v1/imports/{id}/retry/:
@@ -7570,6 +7211,7 @@ paths:
type: string
type: array
id:
+ format: uuid
readOnly: true
type: string
mode:
@@ -7583,6 +7225,7 @@ paths:
revision:
properties:
author:
+ maxLength: 50
type: string
commit_url:
readOnly: true
@@ -7591,12 +7234,15 @@ paths:
format: date-time
type: string
hash:
+ maxLength: 50
type: string
id:
+ format: uuid
type: string
message:
type: string
ref:
+ maxLength: 50
type: string
repo_id:
readOnly: true
@@ -7628,6 +7274,7 @@ paths:
- corpus
- payload
- files
+ description: ''
tags:
- imports
/api/v1/manifest/{id}/act/:
@@ -7646,6 +7293,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7665,6 +7313,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7684,6 +7333,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7704,6 +7354,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7723,6 +7374,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7742,6 +7394,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
security: []
tags:
- iiif
@@ -7768,12 +7421,32 @@ paths:
application/json:
schema:
properties:
- id:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
type: string
- name:
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- required:
- - name
+ results:
+ items:
+ properties:
+ id:
+ format: uuid
+ type: string
+ name:
+ maxLength: 100
+ type: string
+ required:
+ - name
+ type: array
+ type: object
+ description: ''
tags:
- ml
/api/v1/oauth/credentials/:
@@ -7799,28 +7472,57 @@ paths:
application/json:
schema:
properties:
- account_name:
+ count:
+ example: 123
+ type: integer
+ next:
nullable: true
type: string
- id:
- type: string
- provider_display_name:
- type: string
- provider_name:
- enum:
- - GitLabOAuthProvider
- provider_url:
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
type: string
- status:
- enum:
- - created
- - done
- - error
- required:
- - status
- - provider_name
- - provider_display_name
- - provider_url
+ results:
+ items:
+ properties:
+ account_name:
+ maxLength: 100
+ nullable: true
+ type: string
+ id:
+ format: uuid
+ type: string
+ provider_display_name:
+ type: string
+ provider_name:
+ enum:
+ - GitLabOAuthProvider
+ provider_url:
+ format: uri
+ maxLength: 200
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ type: string
+ status:
+ enum:
+ - created
+ - done
+ - error
+ required:
+ - status
+ - provider_name
+ - provider_display_name
+ - provider_url
+ type: array
+ type: object
+ description: ''
tags:
- oauth
/api/v1/oauth/credentials/{id}/:
@@ -7835,33 +7537,8 @@ paths:
schema:
type: string
responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- account_name:
- nullable: true
- type: string
- id:
- type: string
- provider_display_name:
- type: string
- provider_name:
- enum:
- - GitLabOAuthProvider
- provider_url:
- type: string
- status:
- enum:
- - created
- - done
- - error
- required:
- - status
- - provider_name
- - provider_display_name
- - provider_url
+ '204':
+ description: ''
tags:
- oauth
get:
@@ -7881,9 +7558,11 @@ paths:
schema:
properties:
account_name:
+ maxLength: 100
nullable: true
type: string
id:
+ format: uuid
type: string
provider_display_name:
type: string
@@ -7891,6 +7570,14 @@ paths:
enum:
- GitLabOAuthProvider
provider_url:
+ format: uri
+ maxLength: 200
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
status:
enum:
@@ -7902,6 +7589,7 @@ paths:
- provider_name
- provider_display_name
- provider_url
+ description: ''
tags:
- oauth
/api/v1/oauth/credentials/{id}/retry/:
@@ -7922,9 +7610,17 @@ paths:
schema:
properties:
url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
required:
- url
+ description: ''
tags:
- oauth
/api/v1/oauth/providers/:
@@ -7937,17 +7633,27 @@ paths:
content:
application/json:
schema:
- properties:
- default_url:
- type: string
- display_name:
- type: string
- name:
- type: string
- required:
- - name
- - display_name
- - default_url
+ items:
+ properties:
+ default_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ type: string
+ display_name:
+ type: string
+ name:
+ type: string
+ required:
+ - name
+ - display_name
+ - default_url
+ type: array
+ description: ''
tags:
- oauth
/api/v1/oauth/providers/{provider}/signin/:
@@ -7965,7 +7671,10 @@ paths:
'200':
content:
application/json:
- schema: {}
+ schema:
+ items: {}
+ type: array
+ description: ''
tags:
- oauth
/api/v1/page/{id}/:
@@ -7992,12 +7701,15 @@ paths:
nullable: true
type: number
id:
+ format: uuid
type: string
ml_class:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
@@ -8005,12 +7717,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -8037,8 +7752,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -8053,6 +7770,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
type: string
image:
properties:
@@ -8060,6 +7778,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -8083,6 +7802,8 @@ paths:
- status
type: object
nb:
+ maximum: 2147483647
+ minimum: 0
nullable: true
type: integer
page_type:
@@ -8095,12 +7816,15 @@ paths:
- plat
- copy
parents:
+ items:
+ type: array
readOnly: true
type: array
transcriptions:
items:
properties:
id:
+ format: uuid
type: string
score:
nullable: true
@@ -8108,12 +7832,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -8140,12 +7867,25 @@ paths:
zone:
properties:
center:
+ items:
+ type: integer
type: array
id:
+ format: uuid
type: string
image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\\
+ .(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\\
+ .]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
polygon:
+ items:
+ type: array
type: array
url:
readOnly: true
@@ -8167,6 +7907,7 @@ paths:
- corpus
- transcriptions
- classifications
+ description: ''
security: []
tags:
- elements
@@ -8195,6 +7936,7 @@ paths:
content:
application/json:
schema: {}
+ description: ''
tags:
- ml
/api/v1/pages/:
@@ -8212,111 +7954,153 @@ paths:
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
- required:
- - name
- type: object
- date_from:
- type: string
- date_to:
- type: string
- id:
- type: string
- name:
- type: string
- parent_paths:
- type: array
- total_transcriptions:
- type: integer
- transcriptions:
- items:
- properties:
- id:
- type: string
- score:
- nullable: true
- type: number
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- text:
- nullable: true
- type: string
- type:
- enum:
- - page
- - paragraph
- - line
- - word
- - character
- zone:
+ in: query
+ name: page_size
+ required: false
+ schema:
+ type: integer
+ responses:
+ '200':
+ content:
+ application/json:
+ schema:
+ properties:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ corpus:
properties:
- center:
- type: array
id:
+ format: uuid
type: string
- image_url:
- type: string
- polygon:
- type: array
- url:
- readOnly: true
+ name:
+ maxLength: 250
type: string
+ public:
+ type: boolean
required:
- - polygon
- - center
- - image_url
+ - name
type: object
+ date_from:
+ type: string
+ date_to:
+ type: string
+ id:
+ format: uuid
+ type: string
+ name:
+ type: string
+ parent_paths:
+ items:
+ type: array
+ type: array
+ total_transcriptions:
+ type: integer
+ transcriptions:
+ items:
+ properties:
+ id:
+ format: uuid
+ type: string
+ score:
+ nullable: true
+ type: number
+ source:
+ properties:
+ id:
+ format: uuid
+ type: string
+ internal:
+ type: boolean
+ revision:
+ maxLength: 100
+ type: string
+ slug:
+ maxLength: 100
+ type: string
+ type:
+ enum:
+ - classifier
+ - recognizer
+ - ner
+ - dla
+ required:
+ - type
+ - slug
+ - revision
+ - internal
+ type: object
+ text:
+ nullable: true
+ type: string
+ type:
+ enum:
+ - page
+ - paragraph
+ - line
+ - word
+ - character
+ zone:
+ properties:
+ center:
+ items:
+ type: integer
+ type: array
+ id:
+ format: uuid
+ type: string
+ image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\\
+ d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
+ d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF\
+ 0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF\
+ 0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\\
+ Z"
+ type: string
+ polygon:
+ items:
+ type: array
+ type: array
+ url:
+ readOnly: true
+ type: string
+ required:
+ - polygon
+ - center
+ - image_url
+ type: object
+ required:
+ - type
+ - zone
+ - source
+ type: array
required:
- - type
- - zone
- - source
+ - name
+ - transcriptions
+ - total_transcriptions
+ - parent_paths
+ - corpus
+ - date_from
+ - date_to
type: array
- required:
- - name
- - transcriptions
- - total_transcriptions
- - parent_paths
- - corpus
- - date_from
- - date_to
+ type: object
+ description: ''
security: []
tags:
- search
@@ -8344,8 +8128,10 @@ paths:
items:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
type:
enum:
@@ -8359,12 +8145,15 @@ paths:
- name
type: array
id:
+ format: uuid
type: string
ml_class:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
@@ -8372,12 +8161,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -8394,12 +8186,25 @@ paths:
zone:
properties:
center:
+ items:
+ type: integer
type: array
id:
+ format: uuid
type: string
image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF\
+ 0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
+ .(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
+ -\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
+ d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
polygon:
+ items:
+ type: array
type: array
url:
readOnly: true
@@ -8414,6 +8219,7 @@ paths:
- ml_class
- zone
- elements
+ description: ''
security: []
tags:
- elements
@@ -8435,8 +8241,10 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
page:
properties:
@@ -8447,12 +8255,15 @@ paths:
nullable: true
type: number
id:
+ format: uuid
type: string
ml_class:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 100
type: string
required:
- name
@@ -8460,12 +8271,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -8492,8 +8306,10 @@ paths:
corpus:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
public:
type: boolean
@@ -8508,6 +8324,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
type: string
image:
properties:
@@ -8515,6 +8332,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
path:
@@ -8538,6 +8356,8 @@ paths:
- status
type: object
nb:
+ maximum: 2147483647
+ minimum: 0
nullable: true
type: integer
page_type:
@@ -8550,12 +8370,15 @@ paths:
- plat
- copy
parents:
+ items:
+ type: array
readOnly: true
type: array
transcriptions:
items:
properties:
id:
+ format: uuid
type: string
score:
nullable: true
@@ -8563,12 +8386,15 @@ paths:
source:
properties:
id:
+ format: uuid
type: string
internal:
type: boolean
revision:
+ maxLength: 100
type: string
slug:
+ maxLength: 100
type: string
type:
enum:
@@ -8595,12 +8421,26 @@ paths:
zone:
properties:
center:
+ items:
+ type: integer
type: array
id:
+ format: uuid
type: string
image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\\
+ d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1\
+ -\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1\
+ -\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
+ -\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
+ d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
polygon:
+ items:
+ type: array
type: array
url:
readOnly: true
@@ -8626,12 +8466,25 @@ paths:
zone:
properties:
center:
+ items:
+ type: integer
type: array
id:
+ format: uuid
type: string
image_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\\
+ s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)){3}|\\[[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF\
+ 0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1-\uFFFF0-9])?(?:\\\
+ .(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
+ -\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
+ d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
polygon:
+ items:
+ type: array
type: array
url:
readOnly: true
@@ -8645,6 +8498,7 @@ paths:
- name
- page
- zone
+ description: ''
security: []
tags:
- elements
@@ -8661,8 +8515,12 @@ paths:
element:
type: string
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
source:
type: string
@@ -8692,8 +8550,12 @@ paths:
element:
type: string
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
source:
type: string
@@ -8713,6 +8575,7 @@ paths:
- text
- score
- type
+ description: ''
tags:
- ml
/api/v1/transcription/bulk/:
@@ -8734,8 +8597,12 @@ paths:
items:
properties:
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
text:
type: string
@@ -8771,8 +8638,12 @@ paths:
items:
properties:
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
text:
type: string
@@ -8793,6 +8664,7 @@ paths:
- parent
- recognizer
- transcriptions
+ description: ''
tags:
- ml
put:
@@ -8813,8 +8685,12 @@ paths:
items:
properties:
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
text:
type: string
@@ -8850,8 +8726,12 @@ paths:
items:
properties:
polygon:
+ items:
+ type: array
type: array
score:
+ maximum: 1
+ minimum: 0
type: number
text:
type: string
@@ -8872,6 +8752,7 @@ paths:
- parent
- recognizer
- transcriptions
+ description: ''
tags:
- ml
/api/v1/transcription/{id}/entities/:
@@ -8903,85 +8784,88 @@ paths:
application/json:
schema:
properties:
- entity:
- properties:
- dates:
- items:
+ count:
+ example: 123
+ type: integer
+ next:
+ nullable: true
+ type: string
+ number:
+ example: 123
+ type: integer
+ previous:
+ nullable: true
+ type: string
+ results:
+ items:
+ properties:
+ entity:
properties:
- day:
+ dates:
+ items:
+ properties:
+ day:
+ maximum: 31
+ minimum: 1
+ nullable: true
+ type: integer
+ month:
+ maximum: 12
+ minimum: 1
+ nullable: true
+ type: integer
+ type:
+ enum:
+ - exact
+ - lower
+ - upper
+ - unknown
+ year:
+ minimum: 0
+ type: integer
+ required:
+ - type
+ - year
+ - month
+ - day
nullable: true
- type: integer
- month:
+ type: array
+ id:
+ format: uuid
+ type: string
+ metas:
nullable: true
- type: integer
+ type: object
+ name:
+ type: string
type:
enum:
- - exact
- - lower
- - upper
- - unknown
- year:
- type: integer
+ - person
+ - location
+ - subject
+ - organization
+ - misc
+ - number
+ - date
+ validated:
+ type: boolean
required:
+ - name
- type
- - year
- - month
- - day
- nullable: true
- type: array
- id:
- type: string
- metas:
- nullable: true
- type: string
- name:
- type: string
- source:
- properties:
- id:
- type: string
- internal:
- type: boolean
- revision:
- type: string
- slug:
- type: string
- type:
- enum:
- - classifier
- - recognizer
- - ner
- - dla
- required:
- - type
- - slug
- - revision
- - internal
- type: object
- type:
- enum:
- - person
- - location
- - subject
- - organization
- - misc
- - number
- - date
- validated:
- type: boolean
- required:
- - name
- - type
- - source
- type: object
- length:
- type: integer
- offset:
- type: integer
- required:
- - entity
- - offset
- - length
+ type: object
+ length:
+ minimum: 0
+ type: integer
+ offset:
+ minimum: 0
+ type: integer
+ required:
+ - entity
+ - offset
+ - length
+ type: array
+ type: object
+ description: ''
tags:
- entities
/api/v1/transcription/{id}/entity/:
@@ -9003,8 +8887,10 @@ paths:
entity:
type: string
length:
+ minimum: 0
type: integer
offset:
+ minimum: 0
type: integer
required:
- entity
@@ -9020,13 +8906,16 @@ paths:
entity:
type: string
length:
+ minimum: 0
type: integer
offset:
+ minimum: 0
type: integer
required:
- entity
- offset
- length
+ description: ''
tags:
- entities
/api/v1/user/:
@@ -9035,27 +8924,8 @@ paths:
operationId: Logout
parameters: []
responses:
- '200':
- content:
- application/json:
- schema:
- properties:
- auth_token:
- readOnly: true
- type: string
- email:
- readOnly: true
- type: string
- id:
- readOnly: true
- type: integer
- is_admin:
- readOnly: true
- type: boolean
- verified_email:
- readOnly: true
- type: boolean
- required: []
+ '204':
+ description: ''
tags:
- users
get:
@@ -9072,6 +8942,7 @@ paths:
readOnly: true
type: string
email:
+ format: email
readOnly: true
type: string
id:
@@ -9084,6 +8955,7 @@ paths:
readOnly: true
type: boolean
required: []
+ description: ''
tags:
- users
patch:
@@ -9097,6 +8969,7 @@ paths:
schema:
properties:
password:
+ maxLength: 128
type: string
writeOnly: true
x-name: body
@@ -9110,6 +8983,7 @@ paths:
readOnly: true
type: string
email:
+ format: email
readOnly: true
type: string
id:
@@ -9122,6 +8996,7 @@ paths:
readOnly: true
type: boolean
required: []
+ description: ''
tags:
- users
put:
@@ -9135,6 +9010,7 @@ paths:
schema:
properties:
password:
+ maxLength: 128
type: string
writeOnly: true
required:
@@ -9150,6 +9026,7 @@ paths:
readOnly: true
type: string
email:
+ format: email
readOnly: true
type: string
id:
@@ -9162,6 +9039,7 @@ paths:
readOnly: true
type: boolean
required: []
+ description: ''
tags:
- users
/api/v1/user/login/:
@@ -9175,6 +9053,7 @@ paths:
schema:
properties:
email:
+ format: email
type: string
password:
type: string
@@ -9190,9 +9069,11 @@ paths:
schema:
properties:
email:
+ format: email
type: string
required:
- email
+ description: ''
security: []
tags:
- users
@@ -9207,6 +9088,8 @@ paths:
schema:
properties:
email:
+ format: email
+ maxLength: 255
type: string
required:
- email
@@ -9218,9 +9101,12 @@ paths:
schema:
properties:
email:
+ format: email
+ maxLength: 255
type: string
required:
- email
+ description: ''
security: []
tags:
- users
@@ -9235,6 +9121,7 @@ paths:
schema:
properties:
email:
+ format: email
type: string
required:
- email
@@ -9246,9 +9133,11 @@ paths:
schema:
properties:
email:
+ format: email
type: string
required:
- email
+ description: ''
security: []
tags:
- users
@@ -9283,6 +9172,7 @@ paths:
schema:
properties: {}
required: []
+ description: ''
security: []
tags:
- users
@@ -9297,8 +9187,12 @@ paths:
schema:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
derivation:
type: string
@@ -9306,16 +9200,22 @@ paths:
farm:
type: string
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
public_key:
type: string
writeOnly: true
tags:
+ items:
+ type: string
type: array
required:
- farm
@@ -9336,25 +9236,36 @@ paths:
readOnly: true
type: string
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
type: string
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
refresh_token:
readOnly: true
type: string
tags:
+ items:
+ type: string
type: array
required:
- farm
@@ -9362,6 +9273,7 @@ paths:
- cpu_cores
- cpu_frequency
- gpu_count
+ description: ''
security: []
tags:
- ponos
@@ -9392,6 +9304,7 @@ paths:
type: array
required:
- actions
+ description: ''
security:
- agentAuth: []
tags:
@@ -9421,6 +9334,7 @@ paths:
type: string
required:
- refresh
+ description: ''
security:
- agentAuth: []
tags:
@@ -9468,28 +9382,41 @@ paths:
agent:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
seed:
+ maxLength: 64
+ pattern: ^[0-9a-f]{64}$
type: string
required:
- name
type: object
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
required:
@@ -9503,8 +9430,16 @@ paths:
readOnly: true
type: integer
full_log:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
id:
+ format: uuid
readOnly: true
type: string
logs:
@@ -9531,6 +9466,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -9540,6 +9477,7 @@ paths:
- logs
- full_log
- agent
+ description: ''
security: []
tags:
- ponos
@@ -9561,28 +9499,41 @@ paths:
agent:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
seed:
+ maxLength: 64
+ pattern: ^[0-9a-f]{64}$
type: string
required:
- name
type: object
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
required:
@@ -9593,6 +9544,13 @@ paths:
- gpu_count
type: object
full_log:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
+ -\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
+ d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
logs:
type: string
@@ -9607,6 +9565,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
x-name: body
responses:
@@ -9618,28 +9578,41 @@ paths:
agent:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
seed:
+ maxLength: 64
+ pattern: ^[0-9a-f]{64}$
type: string
required:
- name
type: object
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
required:
@@ -9653,8 +9626,16 @@ paths:
readOnly: true
type: integer
full_log:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
id:
+ format: uuid
readOnly: true
type: string
logs:
@@ -9681,6 +9662,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -9690,6 +9673,7 @@ paths:
- logs
- full_log
- agent
+ description: ''
security:
- agentAuth: []
tags:
@@ -9712,28 +9696,41 @@ paths:
agent:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
seed:
+ maxLength: 64
+ pattern: ^[0-9a-f]{64}$
type: string
required:
- name
type: object
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
required:
@@ -9744,6 +9741,13 @@ paths:
- gpu_count
type: object
full_log:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\.(?!-)(?:[a-z\xA1\
+ -\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\.?|localhost))(?::\\\
+ d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
logs:
type: string
@@ -9758,6 +9762,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
required:
- state
@@ -9774,28 +9780,41 @@ paths:
agent:
properties:
cpu_cores:
+ maximum: 32767
+ minimum: 1
type: integer
cpu_frequency:
+ maximum: 9223372036854775807
+ minimum: 1
type: integer
farm:
properties:
id:
+ format: uuid
type: string
name:
+ maxLength: 250
type: string
seed:
+ maxLength: 64
+ pattern: ^[0-9a-f]{64}$
type: string
required:
- name
type: object
gpu_count:
+ maximum: 32767
+ minimum: 0
type: integer
gpu_names:
nullable: true
type: string
hostname:
+ maxLength: 64
+ pattern: ^[-a-zA-Z0-9_]+$
type: string
id:
+ format: uuid
readOnly: true
type: string
required:
@@ -9809,8 +9828,16 @@ paths:
readOnly: true
type: integer
full_log:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
type: string
id:
+ format: uuid
readOnly: true
type: string
logs:
@@ -9837,6 +9864,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -9846,6 +9875,7 @@ paths:
- logs
- full_log
- agent
+ description: ''
security:
- agentAuth: []
tags:
@@ -9866,17 +9896,28 @@ paths:
content:
application/json:
schema:
- properties:
- s3_url:
- type: string
- slug:
- readOnly: true
- type: string
- task_id:
- type: string
- required:
- - task_id
- - s3_url
+ items:
+ properties:
+ s3_url:
+ format: uri
+ pattern: "^(?:[a-z0-9\\.\\-\\+]*)://(?:[^\\s:@/]+(?::[^\\s:@/]*)?@)?(?:(?:25[0-5]|2[0-4]\\\
+ d|[0-1]?\\d?\\d)(?:\\.(?:25[0-5]|2[0-4]\\d|[0-1]?\\d?\\d)){3}|\\\
+ [[0-9a-f:\\.]+\\]|([a-z\xA1-\uFFFF0-9](?:[a-z\xA1-\uFFFF0-9-]{0,61}[a-z\xA1\
+ -\uFFFF0-9])?(?:\\.(?!-)[a-z\xA1-\uFFFF0-9-]{1,63}(?<!-))*\\\
+ .(?!-)(?:[a-z\xA1-\uFFFF-]{2,63}|xn--[a-z0-9]{1,59})(?<!-)\\\
+ .?|localhost))(?::\\d{2,5})?(?:[/?#][^\\s]*)?\\Z"
+ type: string
+ slug:
+ readOnly: true
+ type: string
+ task_id:
+ format: uuid
+ type: string
+ required:
+ - task_id
+ - s3_url
+ type: array
+ description: ''
security:
- agentAuth: []
tags:
@@ -9903,6 +9944,7 @@ paths:
env:
type: object
id:
+ format: uuid
readOnly: true
type: string
image:
@@ -9920,6 +9962,7 @@ paths:
- image
- command
- env
+ description: ''
security:
- agentAuth: []
tags:
@@ -9946,6 +9989,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
type: string
state:
enum:
@@ -9964,6 +10008,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
parents:
@@ -9988,6 +10033,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -9998,6 +10045,7 @@ paths:
required:
- state
- tasks
+ description: ''
security: []
tags:
- ponos
@@ -10017,6 +10065,7 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
state:
enum:
@@ -10035,6 +10084,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
parents:
@@ -10059,6 +10109,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -10078,6 +10130,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
type: string
state:
enum:
@@ -10096,6 +10149,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
parents:
@@ -10120,6 +10174,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -10130,6 +10186,7 @@ paths:
required:
- state
- tasks
+ description: ''
tags:
- ponos
put:
@@ -10148,6 +10205,7 @@ paths:
schema:
properties:
id:
+ format: uuid
type: string
state:
enum:
@@ -10166,6 +10224,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
parents:
@@ -10190,6 +10249,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -10212,6 +10273,7 @@ paths:
readOnly: true
type: string
id:
+ format: uuid
type: string
state:
enum:
@@ -10230,6 +10292,7 @@ paths:
readOnly: true
type: integer
id:
+ format: uuid
readOnly: true
type: string
parents:
@@ -10254,6 +10317,8 @@ paths:
- stopping
- stopped
tags:
+ items:
+ type: string
type: array
url:
readOnly: true
@@ -10264,6 +10329,7 @@ paths:
required:
- state
- tasks
+ description: ''
tags:
- ponos
security: