nlpsandbox-schemas/openapi/data-node/paths/annotations.yaml at 7eda1b9e2c40d6f98d0b0938db94d432bf65e6d4 · nlpsandbox/nlpsandbox-schemas · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
parameters:
  - in: path
    name: datasetId
    description: The ID of the dataset
    required: true
    schema:
      $ref: ../components/parameters/DatasetId.yaml
  - in: path
    name: annotationStoreId
    description: The ID of the annotation store
    required: true
    schema:
      $ref: ../components/parameters/AnnotationStoreId.yaml
post:
  tags:
    - Annotation
  summary: Create an annotation
  description: Create an annotation
  operationId: createAnnotation
  security:
    - ApiKeyAuth: []
  parameters:
    - in: query
      name: annotationId
      description: The ID of the annotation that is being created
      required: true
      schema:
        $ref: ../components/parameters/AnnotationId.yaml
  requestBody:
    content:
      application/json:
        schema:
          $ref: ../components/schemas/AnnotationCreateRequest.yaml
  responses:
    '201':
      content:
        application/json:
          schema:
            $ref: ../components/schemas/AnnotationCreateResponse.yaml
      description: Success
    '400':
      $ref: ../../commons/components/responses/BadRequest.yaml
    '409':
      $ref: ../../commons/components/responses/Conflict.yaml
    '500':
      $ref: ../../commons/components/responses/InternalServerError.yaml
get:
  tags:
    - Annotation
  summary: List the annotations in an annotation store
  description: Returns the annotations in an annotation store
  operationId: listAnnotations
  security:
    - ApiKeyAuth: []
  parameters:
    - in: query
      name: limit
      description: Maximum number of results returned
      required: false
      schema:
        $ref: ../../commons/components/parameters/PageLimit.yaml
    - in: query
      name: offset
      description: Index of the first result that must be returned
      required: false
      schema:
        $ref: ../../commons/components/parameters/PageOffset.yaml
  responses:
    '200':
      content:
        application/json:
          schema:
            $ref: ../components/schemas/PageOfAnnotations.yaml
      description: Success
    '400':
      $ref: ../../commons/components/responses/BadRequest.yaml
    '500':
      $ref: ../../commons/components/responses/InternalServerError.yaml