From 2e2fc18dcc721e2c9242317236b82c3620bd575c Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sat, 25 May 2024 15:34:54 +0200 Subject: [PATCH] events-backend: update schema Signed-off-by: Patrik Oldsberg --- .../events-backend/src/schema/openapi.generated.ts | 11 +++-------- plugins/events-backend/src/schema/openapi.yaml | 11 ++--------- .../events-node/src/generated/models/Event.model.ts | 5 ++++- 3 files changed, 9 insertions(+), 18 deletions(-) diff --git a/plugins/events-backend/src/schema/openapi.generated.ts b/plugins/events-backend/src/schema/openapi.generated.ts index d9b3c9045c..4b1db5aeb0 100644 --- a/plugins/events-backend/src/schema/openapi.generated.ts +++ b/plugins/events-backend/src/schema/openapi.generated.ts @@ -73,7 +73,6 @@ export const spec = { description: 'The topic that the event is published on', }, payload: { - $ref: '#/components/schemas/JsonObject', description: 'The event payload', }, }, @@ -117,11 +116,6 @@ export const spec = { }, required: ['error', 'request', 'response'], }, - JsonObject: { - type: 'object', - properties: {}, - additionalProperties: {}, - }, }, securitySchemes: { JWT: { @@ -269,8 +263,9 @@ export const spec = { }, }, }, - '201': { - description: 'Block poll response, new events are available', + '202': { + description: + 'No new events are available. Response will block until the client should try again.', }, default: { $ref: '#/components/responses/ErrorResponse', diff --git a/plugins/events-backend/src/schema/openapi.yaml b/plugins/events-backend/src/schema/openapi.yaml index 632a884139..0d228a7b0b 100644 --- a/plugins/events-backend/src/schema/openapi.yaml +++ b/plugins/events-backend/src/schema/openapi.yaml @@ -39,7 +39,6 @@ components: type: string description: The topic that the event is published on payload: - $ref: '#/components/schemas/JsonObject' description: The event payload Error: @@ -76,12 +75,6 @@ components: - error - request - response - - JsonObject: - type: object - properties: {} - # Free form object. - additionalProperties: {} securitySchemes: JWT: type: http @@ -178,8 +171,8 @@ paths: $ref: '#/components/schemas/Event' required: - results - '201': - description: Block poll response, new events are available + '202': + description: No new events are available. Response will block until the client should try again. default: $ref: '#/components/responses/ErrorResponse' security: diff --git a/plugins/events-node/src/generated/models/Event.model.ts b/plugins/events-node/src/generated/models/Event.model.ts index b5a13b4d8d..a196b42db7 100644 --- a/plugins/events-node/src/generated/models/Event.model.ts +++ b/plugins/events-node/src/generated/models/Event.model.ts @@ -23,5 +23,8 @@ export interface Event { * The topic that the event is published on */ topic: string; - payload: { [key: string]: any }; + /** + * The event payload + */ + payload: any | null; }