From 29fd4f8d2eaa9725736ea6f08813779c876d9def Mon Sep 17 00:00:00 2001 From: kong-apiops <122612077+kong-apiops@users.noreply.github.com> Date: Thu, 16 Nov 2023 12:32:44 +0000 Subject: [PATCH] Automated OAS update: openapi.yaml --- openapi.yaml | 498 ++++++++++++++++++++++++++++++++------------------- 1 file changed, 309 insertions(+), 189 deletions(-) diff --git a/openapi.yaml b/openapi.yaml index 4fca68a..b87c0ff 100644 --- a/openapi.yaml +++ b/openapi.yaml @@ -368,6 +368,9 @@ paths: application/json: schema: $ref: '#/components/schemas/RegisterPayload' + examples: + RegisterDeveloperRequestExample1: + $ref: '#/components/examples/RegisterDeveloperRequestExample1' responses: '201': description: the developer has been properly registered. @@ -2290,15 +2293,6 @@ components: example: /pet method: type: string - enum: - - get - - patch - - post - - put - - delete - - options - - connect - - trace example: post operation_id: type: string @@ -2517,161 +2511,206 @@ components: enum: - application/json - application/vnd.konnect.document-nodes+json - BaseNode: + NodeChildren: + description: List of children nodes of the current node + type: array + items: + $ref: '#/components/schemas/ChildNode' + HeadingBlock: type: object required: - type properties: type: type: string - DocumentBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - version: - type: string - description: content of the document - example: - type: doc - content: - - type: paragraph - content: - - type: text - text: Hello World - BlockNode: - allOf: - - $ref: '#/components/schemas/BaseNode' - - type: object - properties: - children: - description: List of children nodes of the current node - type: array - items: - $ref: '#/components/schemas/AnyNode' - HeadingBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - level: - description: Level of the heading which maps to HTML tag - type: number - minimum: 1 - maximum: 6 + enum: + - heading + level: + description: Level of the heading which maps to HTML tag + type: number + minimum: 1 + maximum: 6 + children: + $ref: '#/components/schemas/NodeChildren' BlockQuoteBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - blockquote + children: + $ref: '#/components/schemas/NodeChildren' ParagraphBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - paragraph + children: + $ref: '#/components/schemas/NodeChildren' TextBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - text_block + children: + $ref: '#/components/schemas/NodeChildren' BreakBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - break + children: + $ref: '#/components/schemas/NodeChildren' CodeBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - lang: - type: string + type: object + required: + - type + properties: + type: + type: string + enum: + - code_block + lang: + type: string + children: + $ref: '#/components/schemas/NodeChildren' ListBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - isOrdered: - description: Defines if the list is ordered or not - type: boolean + type: object + required: + - type + properties: + type: + type: string + enum: + - list + isOrdered: + description: Defines if the list is ordered or not + type: boolean + children: + $ref: '#/components/schemas/NodeChildren' ListItemBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - list_item + children: + $ref: '#/components/schemas/NodeChildren' Text: - allOf: - - $ref: '#/components/schemas/BaseNode' - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - text: - type: string - hardBreak: - description: > - If this property is true the end of this block should - - be a carriage return and not concatenated to the next Text - block. - type: boolean - softBreak: - description: > - If this property is true the end of this block should should be - - concatenated with a space caracter before the next block. This - is - - the flag showing that the parsed markdown block was at the end - of - - the line. - type: boolean + type: object + required: + - type + properties: + type: + type: string + enum: + - text + text: + type: string + hardBreak: + description: | + If this property is true the end of this block should + be a carriage return and not concatenated to the next Text block. + type: boolean + softBreak: + description: | + If this property is true the end of this block should should be + concatenated with a space caracter before the next block. This is + the flag showing that the parsed markdown block was at the end of + the line. + type: boolean + children: + $ref: '#/components/schemas/NodeChildren' Emphasis: - allOf: - - $ref: '#/components/schemas/BaseNode' - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - level: - type: number - minimum: 1 - maximum: 2 - description: | - Level of emphasis - 1 - italic - 2 - bold + type: object + required: + - type + properties: + type: + type: string + enum: + - emphasis + level: + type: number + minimum: 1 + maximum: 2 + description: | + Level of emphasis + 1 - italic + 2 - bold + children: + $ref: '#/components/schemas/NodeChildren' Code: - allOf: - - $ref: '#/components/schemas/BaseNode' - - $ref: '#/components/schemas/BlockNode' + type: object + required: + - type + properties: + type: + type: string + enum: + - code + children: + $ref: '#/components/schemas/NodeChildren' Link: - allOf: - - $ref: '#/components/schemas/BaseNode' - - type: object - properties: - href: - description: Target url of the link - type: string - title: - description: Title of the link - type: string + type: object + required: + - type + properties: + type: + type: string + enum: + - link + href: + description: Target url of the link + type: string + title: + description: Title of the link + type: string Image: - allOf: - - $ref: '#/components/schemas/BaseNode' - - type: object - properties: - url: - description: Url of the image - type: string - alt: - description: Alternate tag of the image - type: string - title: - description: Title of the image - type: string + type: object + required: + - type + properties: + type: + type: string + enum: + - image + url: + description: Url of the image + type: string + alt: + description: Alternate tag of the image + type: string + title: + description: Title of the image + type: string StrikeThrough: - allOf: - - $ref: '#/components/schemas/BaseNode' - TaskCheckbox: - allOf: - - $ref: '#/components/schemas/BaseNode' - - type: object - properties: - checked: - type: boolean - description: State of the checkbox - required: - - checked + type: object + required: + - type + properties: + type: + type: string + enum: + - strikethrough AlignmentKind: type: string enum: @@ -2680,37 +2719,81 @@ components: - center - none TableAlignments: + type: array + nullable: true + items: + $ref: '#/components/schemas/AlignmentKind' + TableBlock: type: object + required: + - type + - alignments properties: + type: + type: string + enum: + - table alignments: - type: array - nullable: true - items: - $ref: '#/components/schemas/AlignmentKind' + $ref: '#/components/schemas/TableAlignments' + children: + $ref: '#/components/schemas/NodeChildren' + TableHeaderBlock: + type: object required: + - type - alignments - TableBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - $ref: '#/components/schemas/TableAlignments' - TableHeaderBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - $ref: '#/components/schemas/TableAlignments' + properties: + type: + type: string + enum: + - table_header + alignments: + $ref: '#/components/schemas/TableAlignments' + children: + $ref: '#/components/schemas/NodeChildren' TableCellBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - type: object - properties: - alignment: - $ref: '#/components/schemas/AlignmentKind' + type: object + required: + - type + properties: + type: + type: string + enum: + - table_cell + alignment: + $ref: '#/components/schemas/AlignmentKind' + children: + $ref: '#/components/schemas/NodeChildren' TableRowBlock: - allOf: - - $ref: '#/components/schemas/BlockNode' - - $ref: '#/components/schemas/TableAlignments' - AnyNode: + type: object + required: + - type + - alignments + properties: + type: + type: string + enum: + - table_row + alignments: + $ref: '#/components/schemas/TableAlignments' + children: + $ref: '#/components/schemas/NodeChildren' + TaskCheckbox: + type: object + required: + - checked + - type + properties: + type: + type: string + enum: + - task_checkbox + checked: + type: boolean + description: State of the checkbox + ChildNode: + type: object oneOf: - - $ref: '#/components/schemas/DocumentBlock' - $ref: '#/components/schemas/HeadingBlock' - $ref: '#/components/schemas/BlockQuoteBlock' - $ref: '#/components/schemas/ParagraphBlock' @@ -2732,27 +2815,27 @@ components: - $ref: '#/components/schemas/TaskCheckbox' discriminator: propertyName: type - mapping: - document: '#/components/schemas/DocumentBlock' - heading: '#/components/schemas/HeadingBlock' - blockquote: '#/components/schemas/BlockQuoteBlock' - paragraph: '#/components/schemas/ParagraphBlock' - text_block: '#/components/schemas/TextBlock' - break: '#/components/schemas/BreakBlock' - code_block: '#/components/schemas/CodeBlock' - list: '#/components/schemas/ListBlock' - list_item: '#/components/schemas/ListItemBlock' - text: '#/components/schemas/Text' - emphasis: '#/components/schemas/Emphasis' - code: '#/components/schemas/Code' - link: '#/components/schemas/Link' - image: '#/components/schemas/Image' - strikethrough: '#/components/schemas/StrikeThrough' - task_checkbox: '#/components/schemas/TaskCheckbox' - table: '#/components/schemas/TableBlock' - table_header: '#/components/schemas/TableHeaderBlock' - table_cell: '#/components/schemas/TableCellBlock' - table_row: '#/components/schemas/TableRowBlock' + DocumentBlock: + type: object + required: + - type + properties: + type: + type: string + enum: + - document + version: + type: string + children: + $ref: '#/components/schemas/NodeChildren' + description: content of the document + example: + type: document + content: + - type: paragraph + content: + - type: text + text: Hello World NotAvailableError: allOf: - $ref: '#/components/schemas/BaseError' @@ -2768,6 +2851,13 @@ components: description: The product version id required for registration. type: string format: uuid + scopes: + description: >- + The requested scopes for the registration, requires + developer_managed_scopes to be enabled. + type: array + items: + type: string ListRegistrationsResponse: additionalProperties: false type: object @@ -2837,6 +2927,32 @@ components: resource. type: string format: uuid + granted_scopes: + description: > + Cached list of scopes granted for the given application + registration. + + Use + `/api/v2/applications/{applicationId}/registrations/{registrationId}/granted-scopes` + to get up to date granted scopes from the IDP. + + This property will be omitted if not supported by the application. + type: array + items: + type: string + GetGrantedScopesResponse: + additionalProperties: false + type: object + required: + - scopes + properties: + scopes: + description: >- + List of scopes granted for the given application registration + directly updated from the IDP + type: array + items: + type: string SearchResults: title: SearchResults type: object @@ -3475,6 +3591,10 @@ components: title: Gone instance: konnect:trace:8988732526256293040 detail: The token has expired + RegisterDeveloperRequestExample1: + value: + email: dev@company.com + full_name: Dev Smith ProductActionsExample: value: actions: