micro-api/micro-api-spec.yaml at master · GNZ/micro-api · 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
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
swagger: '2.0'
info:
  version: 1.0.0
  title: MicroApi
  description: >
    **Raspberry Pi image capture and analysis API.**
basePath: /
schemes:
  - http
consumes:
  - application/json
produces:
  - application/json
paths:
  /images:
    get:
      summary: Get all images
      description: Get all images
      responses:
        '200':
          description: List all images
          schema:
            title: Image
            type: array
            items:
              $ref: '#/definitions/Image'
    post:
      summary: Create a new image
      description: Create a new image
      responses:
        '200':
          description: Make a new image
          schema:
            $ref: '#/definitions/Image'

  /images/{id}:
    parameters:
      - name: id
        in: path
        type: string
        required: true
    get:
      summary: Get an image by its ID
      description: Get an image by its ID
      responses:
        200:
          description: Get an image by id
          schema:
            $ref: '#/definitions/Image'
        404:
          description: Image not found
    put:
      summary: Update an image attributes by its ID
      description: Update an image attributes by its ID
      parameters:
        - name: image
          in: body
          required: true
          schema:
            type: object
            properties:
              name:
                type: string
              description:
                type: string
      responses:
        200:
          description: Update an image
          schema:
            $ref: '#/definitions/Image'
        404:
          description: Image not found
    delete:
      summary: Delete an image by its ID
      description: Delete an image by its ID
      responses:
        200:
          description: Delete an image
        404:
          description: Image not found

  /images/{id}/analyses:
    parameters:
      - name: id
        in: path
        type: string
        required: true
    post:
      summary: Analyse image by ID
      description: Analyse image by ID
      parameters:
        - name: analysis
          in: body
          required: true
          schema:
            $ref: '#/definitions/AnalysisType'
      responses:
        200:
          description: Create new analysis
          schema:
            $ref: '#/definitions/Analysis'
        404:
          description: Image not found

definitions:
  AnalysisType:
    type: string
    enum:
      - BLOOD_RED-CELL-COUNT

  Analysis:
    type: object
    properties:
      type:
        $ref: '#/definitions/AnalysisType'
      result:
        type: string

  Image:
    type: object
    properties:
      id:
        type: string
      analyses:
        type: array
        items:
          type: Analysis
          $ref: '#/definitions/Analysis'
      created_at:
        type: string
        format: dateTime
      description:
        type: string
      name:
        type: string