Skip to content

Commit eced26f

Browse files
authored
fix: define openapi groups for audit trail (scaleway#2340)
1 parent 40eaf67 commit eced26f

File tree

1 file changed

+19
-0
lines changed

1 file changed

+19
-0
lines changed

api/audit_trail/v1alpha1/audit_trail_sdk.go

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,41 +196,58 @@ type Resource struct {
196196

197197
// Event: event.
198198
type Event struct {
199+
// ID: ID of the event.
199200
ID string `json:"id"`
200201

202+
// RecordedAt: timestamp of the event.
201203
RecordedAt *time.Time `json:"recorded_at"`
202204

205+
// Locality: locality of the resource attached to the event.
203206
Locality string `json:"locality"`
204207

208+
// Principal: user or IAM application at the origin of the event.
205209
Principal *EventPrincipal `json:"principal"`
206210

211+
// OrganizationID: organization ID containing the event.
207212
OrganizationID string `json:"organization_id"`
208213

214+
// ProjectID: (Optional) Project of the resource attached to the event.
209215
ProjectID *string `json:"project_id"`
210216

217+
// SourceIP: IP address at the origin of the event.
211218
SourceIP net.IP `json:"source_ip"`
212219

220+
// UserAgent: user Agent at the origin of the event.
213221
UserAgent *string `json:"user_agent"`
214222

223+
// ProductName: product name of the resource attached to the event.
215224
ProductName string `json:"product_name"`
216225

226+
// ServiceName: API name called to trigger the event.
217227
ServiceName string `json:"service_name"`
218228

229+
// MethodName: API method called to trigger the event.
219230
MethodName string `json:"method_name"`
220231

232+
// Resource: resource attached to the event.
221233
Resource *Resource `json:"resource"`
222234

235+
// RequestID: unique identifier of the request at the origin of the event.
223236
RequestID string `json:"request_id"`
224237

238+
// RequestBody: request at the origin of the event.
225239
RequestBody *scw.JSONObject `json:"request_body"`
226240

241+
// StatusCode: HTTP status code resulting of the API call.
227242
StatusCode uint32 `json:"status_code"`
228243
}
229244

230245
// Product: product.
231246
type Product struct {
247+
// Title: product title.
232248
Title string `json:"title"`
233249

250+
// Name: product name.
234251
Name string `json:"name"`
235252
}
236253

@@ -289,8 +306,10 @@ type ListProductsRequest struct {
289306

290307
// ListProductsResponse: list products response.
291308
type ListProductsResponse struct {
309+
// Products: list of all products integrated with Audit Trail.
292310
Products []*Product `json:"products"`
293311

312+
// TotalCount: number of integrated products.
294313
TotalCount uint64 `json:"total_count"`
295314
}
296315

0 commit comments

Comments
 (0)