Skip to content

Commit 2ba8952

Browse files
committed
Added new "labels" endpoints to swagger.yaml
1 parent cfc22f0 commit 2ba8952

File tree

1 file changed

+77
-0
lines changed

1 file changed

+77
-0
lines changed

public/swagger.yml

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4297,6 +4297,65 @@ paths:
42974297
description: Not found
42984298
content: {}
42994299

4300+
/extractors/labels:
4301+
post:
4302+
tags:
4303+
- extractions
4304+
summary: Create a new extractor label in the database
4305+
requestBody:
4306+
content:
4307+
application/json:
4308+
schema:
4309+
$ref: '#/components/schemas/ExtractorsLabel'
4310+
responses:
4311+
200:
4312+
description: OK
4313+
content:
4314+
application/json:
4315+
schema:
4316+
$ref: '#/components/schemas/ExtractorsLabel'
4317+
4318+
/extractors/labels/{id}:
4319+
put:
4320+
tags:
4321+
- extractions
4322+
summary: Updates an extractor label in the database
4323+
parameters:
4324+
- name: id
4325+
in: path
4326+
required: true
4327+
schema:
4328+
type: string
4329+
requestBody:
4330+
content:
4331+
application/json:
4332+
schema:
4333+
$ref: '#/components/schemas/ExtractorsLabel'
4334+
responses:
4335+
200:
4336+
description: OK
4337+
content:
4338+
application/json:
4339+
schema:
4340+
$ref: '#/components/schemas/ExtractorsLabel'
4341+
delete:
4342+
tags:
4343+
- extractions
4344+
summary: Deletes an extractor label from the database
4345+
parameters:
4346+
- name: id
4347+
in: path
4348+
required: true
4349+
schema:
4350+
type: string
4351+
responses:
4352+
200:
4353+
description: OK
4354+
content:
4355+
application/json:
4356+
schema:
4357+
$ref: '#/components/schemas/ExtractorsLabel'
4358+
43004359
/extractions/{id}/status:
43014360
get:
43024361
tags:
@@ -5552,6 +5611,24 @@ components:
55525611
- by
55535612
allowDownload:
55545613
type: string
5614+
ExtractorsLabel:
5615+
type: object
5616+
description: An arbitrary text label on which users can filter the Extractor Catalog
5617+
properties:
5618+
id:
5619+
type: string
5620+
example: "5b8e969d5e0e8690971ee23e"
5621+
name:
5622+
type: string
5623+
example: "Image"
5624+
category:
5625+
type: string
5626+
example: "Type"
5627+
extractors:
5628+
type: array
5629+
example: ["ncsa.image.preview", "ncsa.image.metadata"]
5630+
items:
5631+
type: string
55555632

55565633
##############################################################################
55575634
# Parameters #

0 commit comments

Comments
 (0)