api/openapi.yml at master · imagespy/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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
openapi: 3.0.0
info:
  license:
    name: MIT
  title: imagespy API
  version: 2.0.0
servers:
- url: /
paths:
  /v2/images/{reference}:
    get:
      operationId: getImageV2
      parameters:
      - description: The reference of the image
        explode: false
        in: path
        name: reference
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Image'
          description: Successful response
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: unexpected error
      summary: Retrieve an image and its latest image
    post:
      operationId: scrapeImageV2
      parameters:
      - description: The reference of the image
        explode: false
        in: path
        name: reference
        required: true
        schema:
          type: string
        style: simple
      responses:
        201:
          description: Scrape successful
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: unexpected error
      summary: Scrape an image
  /v2/images/{reference}/layers:
    get:
      operationId: listLayersV2
      parameters:
      - description: The reference of the image
        explode: false
        in: path
        name: reference
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Layers'
          description: Successful response
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: unexpected error
      summary: Retrieve the list of layers associated with an image.
  /v2/images/{reference}/children:
    get:
      operationId: listChildrenV2
      parameters:
      - description: The reference of the image
        explode: false
        in: path
        name: reference
        required: true
        schema:
          type: string
        style: simple
      responses:
        200:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Images'
          description: Successful response
        default:
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
          description: unexpected error
      summary: List images that extend from the image given by {reference}.
components:
  parameters:
    reference:
      description: The reference of the image
      explode: false
      in: path
      name: reference
      required: true
      schema:
        type: string
      style: simple
  schemas:
    Image:
      properties:
        digest:
          type: string
        latest_image:
          $ref: '#/components/schemas/LatestImage'
        name:
          type: string
        tags:
          items:
            type: string
          type: array
      required:
      - digest
      - latest_image
      - name
      - tags
    Images:
      items:
        $ref: '#/components/schemas/Image'
      type: array
    LatestImage:
      properties:
        digest:
          type: string
        name:
          type: string
        tags:
          items:
            type: string
          type: array
      required:
      - digest
      - name
      - tags
    Layer:
      properties:
        digest:
          type: string
        source_images:
          items:
            $ref: '#/components/schemas/Image'
          type: array
      required:
      - digest
      - source_images
    Layers:
      items:
        $ref: '#/components/schemas/Layer'
      type: array
    Error:
      properties:
        code:
          format: int32
          type: integer
        message:
          type: string
      required:
      - code
      - message