From 5c02a560f41582d1e2def01bbe2395261b7a4cbe Mon Sep 17 00:00:00 2001 From: Nikolaj Geisle <70372949+Zeegaan@users.noreply.github.com> Date: Thu, 2 May 2024 09:55:09 +0200 Subject: [PATCH] Update openapi for webhooks --- .../Webhook/EventsWebhookController.cs | 2 +- src/Umbraco.Cms.Api.Management/OpenApi.json | 103 ++++++++++++++++++ 2 files changed, 104 insertions(+), 1 deletion(-) diff --git a/src/Umbraco.Cms.Api.Management/Controllers/Webhook/EventsWebhookController.cs b/src/Umbraco.Cms.Api.Management/Controllers/Webhook/EventsWebhookController.cs index 84e48a262a..1bc6362dd4 100644 --- a/src/Umbraco.Cms.Api.Management/Controllers/Webhook/EventsWebhookController.cs +++ b/src/Umbraco.Cms.Api.Management/Controllers/Webhook/EventsWebhookController.cs @@ -22,7 +22,7 @@ public class EventsWebhookController : WebhookControllerBase [HttpGet("events")] [MapToApiVersion("1.0")] - [ProducesResponseType(typeof(PagedViewModel), StatusCodes.Status200OK)] + [ProducesResponseType(typeof(PagedViewModel), StatusCodes.Status200OK)] public Task>> All( CancellationToken cancellationToken, int skip = 0, diff --git a/src/Umbraco.Cms.Api.Management/OpenApi.json b/src/Umbraco.Cms.Api.Management/OpenApi.json index 9272bd6c6d..21d0a81679 100644 --- a/src/Umbraco.Cms.Api.Management/OpenApi.json +++ b/src/Umbraco.Cms.Api.Management/OpenApi.json @@ -32356,6 +32356,58 @@ } ] } + }, + "/umbraco/management/api/v1/webhook/events": { + "get": { + "tags": [ + "Webhook" + ], + "operationId": "GetWebhookEvents", + "parameters": [ + { + "name": "skip", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 0 + } + }, + { + "name": "take", + "in": "query", + "schema": { + "type": "integer", + "format": "int32", + "default": 100 + } + } + ], + "responses": { + "200": { + "description": "Success", + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "$ref": "#/components/schemas/PagedWebhookEventModel" + } + ] + } + } + } + }, + "401": { + "description": "The resource is protected and requires an authentication token" + } + }, + "security": [ + { + "Backoffice User": [ ] + } + ] + } } }, "components": { @@ -40238,6 +40290,30 @@ }, "additionalProperties": false }, + "PagedWebhookEventModel": { + "required": [ + "items", + "total" + ], + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int64" + }, + "items": { + "type": "array", + "items": { + "oneOf": [ + { + "$ref": "#/components/schemas/WebhookEventModel" + } + ] + } + } + }, + "additionalProperties": false + }, "PagedWebhookResponseModel": { "required": [ "items", @@ -43461,6 +43537,7 @@ }, "UserItemResponseModel": { "required": [ + "avatarUrls", "id", "name" ], @@ -43472,6 +43549,12 @@ }, "name": { "type": "string" + }, + "avatarUrls": { + "type": "array", + "items": { + "type": "string" + } } }, "additionalProperties": false @@ -43777,6 +43860,26 @@ }, "additionalProperties": false }, + "WebhookEventModel": { + "required": [ + "alias", + "eventName", + "eventType" + ], + "type": "object", + "properties": { + "eventName": { + "type": "string" + }, + "eventType": { + "type": "string" + }, + "alias": { + "type": "string" + } + }, + "additionalProperties": false + }, "WebhookEventResponseModel": { "required": [ "alias",