From 3e22de3251372fdb97fecf0cd0533896eb73c24a Mon Sep 17 00:00:00 2001 From: Ancor Cruz Date: Fri, 27 Sep 2024 10:42:00 +0100 Subject: [PATCH] feat(events): update openapi.yaml file --- openapi.yaml | 55 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) diff --git a/openapi.yaml b/openapi.yaml index ae52594..085c0c1 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -1187,6 +1187,61 @@ paths: $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/UnprocessableEntity' + get: + tags: + - events + summary: List all events + description: This endpoint is used for retrievign all events. + operationId: findAllEvents + parameters: + - $ref: '#/components/parameters/page' + - $ref: '#/components/parameters/per_page' + - $ref: '#/components/parameters/external_subscription_id' + - name: code + in: query + description: Filter events by its code. + required: false + explode: true + schema: + type: string + example: event-123 + - name: timestamp_from + in: query + description: Filter events by timestamp starting from a specific date. + required: false + explode: true + schema: + type: string + format: date-time + example: '2022-08-08T00:00:00Z' + - name: timestamp_to + in: query + description: Filter events by timestamp up to a specific date. + required: false + explode: true + schema: + type: string + format: date-time + example: '2022-08-08T00:00:00Z' + responses: + '200': + description: Events + content: + application/json: + schema: + type: object + required: + - events + - meta + properties: + events: + type: array + items: + $ref: '#/components/schemas/EventObject' + meta: + $ref: '#/components/schemas/PaginationMeta' + '401': + $ref: '#/components/responses/Unauthorized' /events/batch: post: tags: