cbomkit/openapi.yaml at main · cbomkit/cbomkit · 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
---
openapi: 3.1.0
paths:
  /api:
    get:
      summary: Health test
      description: Health test endpoint
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                examples:
                - status: ok
      tags:
      - Status
  /api/v1/cbom/last/{limit}:
    get:
      summary: Return recently generated CBOMs from the repository
      description: Returns a list of the most recently generated CBOMs. The length
        of the list can by specified via the optional 'limit' parameter.
      parameters:
      - name: limit
        in: path
        required: true
        schema:
          type: integer
          format: int32
      responses:
        "200":
          description: OK
      tags:
      - CBOM Resource
  /api/v1/cbom/{projectIdentifier}:
    post:
      parameters:
      - name: projectIdentifier
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        "200":
          description: OK
      summary: Store CBOM
      tags:
      - CBOM Resource
    get:
      parameters:
      - name: projectIdentifier
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
      summary: Get CBOM
      tags:
      - CBOM Resource
    delete:
      parameters:
      - name: projectIdentifier
        in: path
        required: true
        schema:
          type: string
      responses:
        "200":
          description: OK
      summary: Delete CBOM
      tags:
      - CBOM Resource
  /api/v1/compliance/check:
    get:
      summary: Verify the compliance of a stored CBOM identified by it's PURL against
        a policy
      description: "Returns the JSON sent by the Regulator API, containing various\
        \ information about the compliance of the CBOM for a set policy."
      parameters:
      - name: policyIdentifier
        in: query
        schema:
          type: string
      - name: projectIdentifier
        in: query
        schema:
          type: string
      responses:
        "200":
          description: OK
      tags:
      - Compliance Resource
    post:
      summary: Verify the compliance of a provided CBOM against a policy
      description: "Returns the JSON sent by the Regulator API, containing various\
        \ information about the compliance of the CBOM for a set policy."
      parameters:
      - name: policyIdentifier
        in: query
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: string
        required: true
      responses:
        "200":
          description: OK
      tags:
      - Compliance Resource
  /api/v1/scan:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/ScanRequest"
        required: true
      responses:
        "200":
          description: OK
        "400":
          description: Bad Request
      summary: Scan
      tags:
      - Scanning Resource
components:
  schemas:
    Credentials:
      type: object
      properties:
        username:
          type: string
        password:
          type: string
        pat:
          type: string
    ScanRequest:
      type: object
      properties:
        scanUrl:
          type: string
        branch:
          type: string
        subfolder:
          type: string
        credentials:
          $ref: "#/components/schemas/Credentials"
info:
  title: CBOMkit API
  version: 2.0.0-SNAPSHOT
  description: Service for generating and retrieving CBOMs
servers:
- url: http://localhost:8081
  description: Auto generated value
- url: http://0.0.0.0:8081
  description: Auto generated value