From 0334fd0a78d2e6e992a3c775be541f9c84d1e3b1 Mon Sep 17 00:00:00 2001
From: vrigal <rigal@teklia.com>
Date: Fri, 14 Feb 2020 10:04:16 +0100
Subject: [PATCH 1/2] Remove hidden element's types filters in ListElements
endpoints
---
arkindex/schema.yml | 306 +++++++++++++++++++++-----------------------
1 file changed, 148 insertions(+), 158 deletions(-)
diff --git a/arkindex/schema.yml b/arkindex/schema.yml
index d63cc1a..eac95b1 100644
--- a/arkindex/schema.yml
+++ b/arkindex/schema.yml
@@ -3411,21 +3411,13 @@ paths:
type: string
- type: boolean
- &id027
- description: Restrict to or exclude elements with hidden types; they are excluded
- by default
- in: query
- name: hidden
- required: false
- schema:
- type: boolean
- - &id028
description: Restrict to or exclude elements with folder types
in: query
name: folder
required: false
schema:
type: boolean
- - &id029
+ - &id028
description: Returns best classifications for each element. If not set, elements
best_classes field will always be null
in: query
@@ -3659,8 +3651,8 @@ paths:
type: array
type: object
description: ''
- security: &id030 []
- tags: &id031
+ security: &id029 []
+ tags: &id030
- elements
/api/v1/elements/create/:
post:
@@ -4682,7 +4674,6 @@ paths:
- *id026
- *id027
- *id028
- - *id029
- description: List recursively (parents, grandparents, etc.)
in: query
name: recursive
@@ -4908,8 +4899,8 @@ paths:
type: array
type: object
description: ''
- security: *id030
- tags: *id031
+ security: *id029
+ tags: *id030
/api/v1/elements/{id}/neighbors/:
get:
description: List neighboring elements
@@ -5020,7 +5011,6 @@ paths:
- *id026
- *id027
- *id028
- - *id029
- description: List recursively (children, grandchildren, etc.)
in: query
name: recursive
@@ -5246,8 +5236,8 @@ paths:
type: array
type: object
description: ''
- security: *id030
- tags: *id031
+ security: *id029
+ tags: *id030
/api/v1/entity/:
post:
description: Create a new entity
@@ -5256,7 +5246,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id032
+ schema: &id031
properties:
corpus:
type: string
@@ -5283,9 +5273,9 @@ paths:
- corpus
- ner
application/x-www-form-urlencoded:
- schema: *id032
+ schema: *id031
multipart/form-data:
- schema: *id032
+ schema: *id031
x-name: body
responses:
'200':
@@ -5776,7 +5766,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id033
+ schema: &id032
properties:
child:
type: string
@@ -5789,9 +5779,9 @@ paths:
- child
- role
application/x-www-form-urlencoded:
- schema: *id033
+ schema: *id032
multipart/form-data:
- schema: *id033
+ schema: *id032
x-name: body
responses:
'200':
@@ -5921,7 +5911,7 @@ paths:
responses:
'204':
description: ''
- tags: &id034
+ tags: &id033
- entities
get:
description: Get all information about an entity
@@ -6484,7 +6474,7 @@ paths:
- type
description: ''
security: []
- tags: *id034
+ tags: *id033
patch:
description: Partially update an entity
operationId: PartialUpdateEntity
@@ -6498,7 +6488,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id035
+ schema: &id034
properties:
metas:
nullable: true
@@ -6517,9 +6507,9 @@ paths:
validated:
type: boolean
application/x-www-form-urlencoded:
- schema: *id035
+ schema: *id034
multipart/form-data:
- schema: *id035
+ schema: *id034
x-name: body
responses:
'200':
@@ -7071,7 +7061,7 @@ paths:
- name
- type
description: ''
- tags: *id034
+ tags: *id033
put:
description: Update an entity
operationId: UpdateEntity
@@ -7085,7 +7075,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id036
+ schema: &id035
properties:
metas:
nullable: true
@@ -7107,9 +7097,9 @@ paths:
- name
- type
application/x-www-form-urlencoded:
- schema: *id036
+ schema: *id035
multipart/form-data:
- schema: *id036
+ schema: *id035
x-name: body
responses:
'200':
@@ -7661,7 +7651,7 @@ paths:
- name
- type
description: ''
- tags: *id034
+ tags: *id033
/api/v1/entity/{id}/elements/:
get:
description: Get all elements that have a link with the entity
@@ -7923,7 +7913,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id037
+ schema: &id036
properties:
datafile:
nullable: true
@@ -7949,9 +7939,9 @@ paths:
required:
- hash
application/x-www-form-urlencoded:
- schema: *id037
+ schema: *id036
multipart/form-data:
- schema: *id037
+ schema: *id036
x-name: body
responses:
'200':
@@ -8050,7 +8040,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id038
+ schema: &id037
properties:
url:
format: uri
@@ -8064,9 +8054,9 @@ paths:
required:
- url
application/x-www-form-urlencoded:
- schema: *id038
+ schema: *id037
multipart/form-data:
- schema: *id038
+ schema: *id037
x-name: body
responses:
'200':
@@ -8223,7 +8213,7 @@ paths:
required:
- status
description: ''
- tags: &id040
+ tags: &id039
- images
patch:
description: Update an image's status
@@ -8238,7 +8228,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id039
+ schema: &id038
properties:
status:
enum:
@@ -8246,9 +8236,9 @@ paths:
- unchecked
- error
application/x-www-form-urlencoded:
- schema: *id039
+ schema: *id038
multipart/form-data:
- schema: *id039
+ schema: *id038
x-name: body
responses:
'200':
@@ -8321,7 +8311,7 @@ paths:
required:
- status
description: ''
- tags: *id040
+ tags: *id039
put:
description: Update an image's status
operationId: UpdateImage
@@ -8335,7 +8325,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id041
+ schema: &id040
properties:
status:
enum:
@@ -8345,9 +8335,9 @@ paths:
required:
- status
application/x-www-form-urlencoded:
- schema: *id041
+ schema: *id040
multipart/form-data:
- schema: *id041
+ schema: *id040
x-name: body
responses:
'200':
@@ -8420,7 +8410,7 @@ paths:
required:
- status
description: ''
- tags: *id040
+ tags: *id039
/api/v1/image/{id}/elements/:
get:
description: List elements on an image
@@ -8719,7 +8709,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id042
+ schema: &id041
properties:
chunks:
default: 1
@@ -8778,9 +8768,9 @@ paths:
- ml_tools
- corpus
application/x-www-form-urlencoded:
- schema: *id042
+ schema: *id041
multipart/form-data:
- schema: *id042
+ schema: *id041
x-name: body
responses:
'201':
@@ -8884,7 +8874,7 @@ paths:
responses:
'204':
description: ''
- tags: &id043
+ tags: &id042
- files
get:
description: Get an uploaded file's metadata
@@ -9001,7 +8991,7 @@ paths:
- name
- status
description: ''
- tags: *id043
+ tags: *id042
patch:
description: Update a datafile's status
operationId: PartialUpdateDataFile
@@ -9015,7 +9005,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id044
+ schema: &id043
properties:
name:
maxLength: 100
@@ -9026,9 +9016,9 @@ paths:
- unchecked
- error
application/x-www-form-urlencoded:
- schema: *id044
+ schema: *id043
multipart/form-data:
- schema: *id044
+ schema: *id043
x-name: body
responses:
'200':
@@ -9135,7 +9125,7 @@ paths:
- name
- status
description: ''
- tags: *id043
+ tags: *id042
put:
description: Update a datafile's status
operationId: UpdateDataFile
@@ -9149,7 +9139,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id045
+ schema: &id044
properties:
name:
maxLength: 100
@@ -9163,9 +9153,9 @@ paths:
- name
- status
application/x-www-form-urlencoded:
- schema: *id045
+ schema: *id044
multipart/form-data:
- schema: *id045
+ schema: *id044
x-name: body
responses:
'200':
@@ -9272,7 +9262,7 @@ paths:
- name
- status
description: ''
- tags: *id043
+ tags: *id042
/api/v1/imports/files/create/:
post:
description: 'Create a Datafile.
@@ -9284,7 +9274,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id046
+ schema: &id045
properties:
corpus:
type: string
@@ -9306,9 +9296,9 @@ paths:
- size
- corpus
application/x-www-form-urlencoded:
- schema: *id046
+ schema: *id045
multipart/form-data:
- schema: *id046
+ schema: *id045
x-name: body
responses:
'200':
@@ -9538,7 +9528,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id047
+ schema: &id046
properties:
element_type:
pattern: ^[-a-zA-Z0-9_]+$
@@ -9612,9 +9602,9 @@ paths:
- files
- element_type
application/x-www-form-urlencoded:
- schema: *id047
+ schema: *id046
multipart/form-data:
- schema: *id047
+ schema: *id046
x-name: body
responses:
'200':
@@ -9852,7 +9842,7 @@ paths:
- id
- corpus
description: ''
- tags: &id049
+ tags: &id048
- repos
post:
description: Using the given OAuth credentials, this links an external Git repository
@@ -9868,7 +9858,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id048
+ schema: &id047
properties:
corpus:
format: uuid
@@ -9880,9 +9870,9 @@ paths:
- id
- corpus
application/x-www-form-urlencoded:
- schema: *id048
+ schema: *id047
multipart/form-data:
- schema: *id048
+ schema: *id047
x-name: body
responses:
'200':
@@ -9900,7 +9890,7 @@ paths:
- id
- corpus
description: ''
- tags: *id049
+ tags: *id048
/api/v1/imports/repos/{id}/:
delete:
description: Delete a repository
@@ -9915,7 +9905,7 @@ paths:
responses:
'204':
description: ''
- tags: &id050
+ tags: &id049
- repos
get:
description: Retrieve a repository
@@ -9955,7 +9945,7 @@ paths:
required:
- corpus
description: ''
- tags: *id050
+ tags: *id049
/api/v1/imports/repos/{id}/start/:
get:
description: Start a data import on the latest revision on a repository.
@@ -10049,7 +10039,7 @@ paths:
responses:
'204':
description: ''
- tags: &id051
+ tags: &id050
- imports
get:
description: Retrieve a data import
@@ -10148,7 +10138,7 @@ paths:
- payload
- files
description: ''
- tags: *id051
+ tags: *id050
/api/v1/imports/{id}/retry/:
post:
description: Retry a data import. Can only be used on imports with Error, Failed
@@ -10164,7 +10154,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id052
+ schema: &id051
properties:
corpus:
type: string
@@ -10198,9 +10188,9 @@ paths:
- payload
- files
application/x-www-form-urlencoded:
- schema: *id052
+ schema: *id051
multipart/form-data:
- schema: *id052
+ schema: *id051
x-name: body
responses:
'200':
@@ -10305,7 +10295,7 @@ paths:
responses:
'204':
description: ''
- tags: &id053
+ tags: &id052
- elements
get:
description: Retrieve an existing metadata
@@ -10417,7 +10407,7 @@ paths:
- name
- value
description: ''
- tags: *id053
+ tags: *id052
patch:
description: Partially update an existing metadata
operationId: PartialUpdateMetaData
@@ -10431,7 +10421,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id054
+ schema: &id053
properties:
entity:
type: string
@@ -10448,9 +10438,9 @@ paths:
value:
type: string
application/x-www-form-urlencoded:
- schema: *id054
+ schema: *id053
multipart/form-data:
- schema: *id054
+ schema: *id053
x-name: body
responses:
'200':
@@ -10552,7 +10542,7 @@ paths:
- name
- value
description: ''
- tags: *id053
+ tags: *id052
put:
description: Update an existing metadata
operationId: UpdateMetaData
@@ -10566,7 +10556,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id055
+ schema: &id054
properties:
entity:
type: string
@@ -10587,9 +10577,9 @@ paths:
- name
- value
application/x-www-form-urlencoded:
- schema: *id055
+ schema: *id054
multipart/form-data:
- schema: *id055
+ schema: *id054
x-name: body
responses:
'200':
@@ -10691,7 +10681,7 @@ paths:
- name
- value
description: ''
- tags: *id053
+ tags: *id052
/api/v1/ml-classes/:
get:
description: List available machine learning classes in all corpora.
@@ -10835,7 +10825,7 @@ paths:
responses:
'204':
description: ''
- tags: &id056
+ tags: &id055
- oauth
get:
description: Retrieve OAuth credentials.
@@ -10887,7 +10877,7 @@ paths:
- provider_display_name
- provider_url
description: ''
- tags: *id056
+ tags: *id055
/api/v1/oauth/credentials/{id}/retry/:
get:
description: Retry the OAuth authentication code flow for pending credentials
@@ -10984,7 +10974,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id057
+ schema: &id056
properties:
analyser:
type: string
@@ -11013,9 +11003,9 @@ paths:
- analyser
- regions
application/x-www-form-urlencoded:
- schema: *id057
+ schema: *id056
multipart/form-data:
- schema: *id057
+ schema: *id056
x-name: body
responses:
'200':
@@ -11050,7 +11040,7 @@ paths:
- analyser
- regions
description: ''
- tags: &id059
+ tags: &id058
- ml
put:
description: Add new regions from a machine learning tool; if this tool already
@@ -11060,7 +11050,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id058
+ schema: &id057
properties:
analyser:
type: string
@@ -11089,9 +11079,9 @@ paths:
- analyser
- regions
application/x-www-form-urlencoded:
- schema: *id058
+ schema: *id057
multipart/form-data:
- schema: *id058
+ schema: *id057
x-name: body
responses:
'200':
@@ -11126,7 +11116,7 @@ paths:
- analyser
- regions
description: ''
- tags: *id059
+ tags: *id058
/api/v1/region/{id}/:
get:
description: Retrieve detailed information about a region.
@@ -11319,7 +11309,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id060
+ schema: &id059
properties:
corpus:
type: string
@@ -11337,9 +11327,9 @@ paths:
default: true
type: boolean
application/x-www-form-urlencoded:
- schema: *id060
+ schema: *id059
multipart/form-data:
- schema: *id060
+ schema: *id059
x-name: body
responses:
'200':
@@ -11373,7 +11363,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id061
+ schema: &id060
properties:
element:
type: string
@@ -11404,9 +11394,9 @@ paths:
- score
- type
application/x-www-form-urlencoded:
- schema: *id061
+ schema: *id060
multipart/form-data:
- schema: *id061
+ schema: *id060
x-name: body
responses:
'200':
@@ -11456,7 +11446,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id062
+ schema: &id061
properties:
parent:
type: string
@@ -11493,14 +11483,14 @@ paths:
- recognizer
- transcriptions
application/x-www-form-urlencoded:
- schema: *id062
+ schema: *id061
multipart/form-data:
- schema: *id062
+ schema: *id061
x-name: body
- responses: &id064
+ responses: &id063
'201':
description: All transcriptions have been created.
- tags: &id065
+ tags: &id064
- ml
put:
description: Replace all existing transcriptions from a given recognizer on
@@ -11510,7 +11500,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id063
+ schema: &id062
properties:
parent:
type: string
@@ -11547,12 +11537,12 @@ paths:
- recognizer
- transcriptions
application/x-www-form-urlencoded:
- schema: *id063
+ schema: *id062
multipart/form-data:
- schema: *id063
+ schema: *id062
x-name: body
- responses: *id064
- tags: *id065
+ responses: *id063
+ tags: *id064
/api/v1/transcription/{id}/entities/:
get:
description: List existing entities linked to a specific transcription
@@ -11713,7 +11703,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id066
+ schema: &id065
properties:
entity:
type: string
@@ -11728,9 +11718,9 @@ paths:
- offset
- length
application/x-www-form-urlencoded:
- schema: *id066
+ schema: *id065
multipart/form-data:
- schema: *id066
+ schema: *id065
x-name: body
responses:
'200':
@@ -11761,7 +11751,7 @@ paths:
responses:
'204':
description: ''
- tags: &id067
+ tags: &id066
- users
get:
description: Retrieve information about the authenticated user
@@ -11791,7 +11781,7 @@ paths:
type: boolean
required: []
description: ''
- tags: *id067
+ tags: *id066
patch:
description: Update a user's password. This action is not allowed to users without
confirmed e-mails.
@@ -11800,16 +11790,16 @@ paths:
requestBody:
content:
application/json:
- schema: &id068
+ schema: &id067
properties:
password:
maxLength: 128
type: string
writeOnly: true
application/x-www-form-urlencoded:
- schema: *id068
+ schema: *id067
multipart/form-data:
- schema: *id068
+ schema: *id067
x-name: body
responses:
'200':
@@ -11835,7 +11825,7 @@ paths:
type: boolean
required: []
description: ''
- tags: *id067
+ tags: *id066
put:
description: Update a user's password. This action is not allowed to users without
confirmed e-mails.
@@ -11844,7 +11834,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id069
+ schema: &id068
properties:
password:
maxLength: 128
@@ -11853,9 +11843,9 @@ paths:
required:
- password
application/x-www-form-urlencoded:
- schema: *id069
+ schema: *id068
multipart/form-data:
- schema: *id069
+ schema: *id068
x-name: body
responses:
'200':
@@ -11881,7 +11871,7 @@ paths:
type: boolean
required: []
description: ''
- tags: *id067
+ tags: *id066
/api/v1/user/login/:
post:
description: Login using an email and a password
@@ -11890,7 +11880,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id070
+ schema: &id069
properties:
email:
format: email
@@ -11902,9 +11892,9 @@ paths:
- email
- password
application/x-www-form-urlencoded:
- schema: *id070
+ schema: *id069
multipart/form-data:
- schema: *id070
+ schema: *id069
x-name: body
responses:
'200':
@@ -11929,7 +11919,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id071
+ schema: &id070
properties:
email:
format: email
@@ -11938,9 +11928,9 @@ paths:
required:
- email
application/x-www-form-urlencoded:
- schema: *id071
+ schema: *id070
multipart/form-data:
- schema: *id071
+ schema: *id070
x-name: body
responses:
'200':
@@ -11966,7 +11956,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id072
+ schema: &id071
properties:
email:
format: email
@@ -11974,9 +11964,9 @@ paths:
required:
- email
application/x-www-form-urlencoded:
- schema: *id072
+ schema: *id071
multipart/form-data:
- schema: *id072
+ schema: *id071
x-name: body
responses:
'200':
@@ -12001,7 +11991,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id073
+ schema: &id072
properties:
password:
type: string
@@ -12017,9 +12007,9 @@ paths:
- token
- password
application/x-www-form-urlencoded:
- schema: *id073
+ schema: *id072
multipart/form-data:
- schema: *id073
+ schema: *id072
x-name: body
responses:
'200':
@@ -12040,7 +12030,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id074
+ schema: &id073
properties:
cpu_cores:
maximum: 32767
@@ -12087,9 +12077,9 @@ paths:
- cpu_frequency
- gpu_count
application/x-www-form-urlencoded:
- schema: *id074
+ schema: *id073
multipart/form-data:
- schema: *id074
+ schema: *id073
x-name: body
responses:
'200':
@@ -12187,16 +12177,16 @@ paths:
requestBody:
content:
application/json:
- schema: &id075
+ schema: &id074
properties:
refresh:
type: string
required:
- refresh
application/x-www-form-urlencoded:
- schema: *id075
+ schema: *id074
multipart/form-data:
- schema: *id075
+ schema: *id074
x-name: body
responses:
'200':
@@ -12365,7 +12355,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id076
+ schema: &id075
properties:
agent:
properties:
@@ -12437,9 +12427,9 @@ paths:
type: string
type: array
application/x-www-form-urlencoded:
- schema: *id076
+ schema: *id075
multipart/form-data:
- schema: *id076
+ schema: *id075
x-name: body
responses:
'200':
@@ -12560,7 +12550,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id077
+ schema: &id076
properties:
agent:
properties:
@@ -12637,9 +12627,9 @@ paths:
- full_log
- agent
application/x-www-form-urlencoded:
- schema: *id077
+ schema: *id076
multipart/form-data:
- schema: *id077
+ schema: *id076
x-name: body
responses:
'200':
@@ -12929,7 +12919,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id078
+ schema: &id077
properties:
id:
format: uuid
@@ -12986,9 +12976,9 @@ paths:
- state
type: array
application/x-www-form-urlencoded:
- schema: *id078
+ schema: *id077
multipart/form-data:
- schema: *id078
+ schema: *id077
x-name: body
responses:
'200':
@@ -13073,7 +13063,7 @@ paths:
requestBody:
content:
application/json:
- schema: &id079
+ schema: &id078
properties:
id:
format: uuid
@@ -13133,9 +13123,9 @@ paths:
- state
- tasks
application/x-www-form-urlencoded:
- schema: *id079
+ schema: *id078
multipart/form-data:
- schema: *id079
+ schema: *id078
x-name: body
responses:
'200':
--
GitLab
From dcad0e8c6befe82bda9fdf28be49007876e90caf Mon Sep 17 00:00:00 2001
From: vrigal <rigal@teklia.com>
Date: Mon, 17 Feb 2020 12:40:07 +0100
Subject: [PATCH 2/2] Remove hidden type filter from ImageElements endpoint
---
arkindex/schema.yml | 7 -------
1 file changed, 7 deletions(-)
diff --git a/arkindex/schema.yml b/arkindex/schema.yml
index eac95b1..d20b249 100644
--- a/arkindex/schema.yml
+++ b/arkindex/schema.yml
@@ -8440,13 +8440,6 @@ paths:
required: false
schema:
type: string
- - description: Restrict to or exclude elements with hidden types; they are excluded
- by default
- in: query
- name: hidden
- required: false
- schema:
- type: boolean
- description: Restrict to or exclude elements with folder types
in: query
name: folder
--
GitLab