swagger.yaml 1.78 KB
Newer Older
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
openapi: 3.0.0
#swagger: "2.0"
info:
  title: CheneTAL API
  description: All the tools needed to process a corpus.
  version: 0.1
servers:
  - url: http://api.example.com/v1
    description: Optional server description, e.g. Main (production) server
  - url: http://staging-api.example.com
    description: Optional server description, e.g. Internal staging server for testing
paths: 
  /users:
    get:
      tags: [users]
      summary: Returns all users.
      responses:
        '200':    # status code
          description: A JSON array of all users
          content:
            application/json:
              schema: 
                type: array
                items: 
                  $ref: '#/components/schemas/User'
  /users/{userId}:
    get:
      tags: [users]
      summary: Find user by ID
      description: Returns a single user
      operationId: getUserById
      produces: application/json
      parameters:
      - name: userId
        in: path
        description: ID of user to return
        required: true
        type: integer
      responses:
        200:
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/User'
        400:
          description: invalid ID supplied
        404:
          description: User not found
    put:
      tags: [users]
      summary: Updates a user
      consumes: application/json
      produces: application/json
      parameters:
      - name: 
  /pipelines/{pipelineId}:
    get:
      tags: [corpora]
      summary: Returns a pipeline
      responses:
        '200':
          description: A JSON of the pipeline
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Pipeline'