From b0b033584e0a7cc59d23b993609cdad8a2811a90 Mon Sep 17 00:00:00 2001 From: Sofia Papagiannaki <1632407+papagian@users.noreply.github.com> Date: Wed, 25 Oct 2023 10:27:37 +0300 Subject: [PATCH] Chore: Update OpenAPI specs (#77107) --- public/api-enterprise-spec.json | 9 ++++ public/api-merged.json | 80 ++++++++++++++------------------- public/openapi3.json | 80 ++++++++++++++------------------- 3 files changed, 75 insertions(+), 94 deletions(-) diff --git a/public/api-enterprise-spec.json b/public/api-enterprise-spec.json index 75597c1c321..9701d0b0a76 100644 --- a/public/api-enterprise-spec.json +++ b/public/api-enterprise-spec.json @@ -6304,6 +6304,7 @@ "$ref": "#/definitions/Json" }, "folderId": { + "description": "Deprecated: use FolderUID instead", "type": "integer", "format": "int64" }, @@ -6533,6 +6534,10 @@ "type": "boolean", "example": false }, + "isExternal": { + "type": "boolean", + "example": false + }, "login": { "type": "string", "example": "sa-grafana" @@ -6584,6 +6589,10 @@ "type": "boolean", "example": false }, + "isExternal": { + "type": "boolean", + "example": false + }, "login": { "type": "string", "example": "sa-grafana" diff --git a/public/api-merged.json b/public/api-merged.json index 326dfb0aa18..2292da639b4 100644 --- a/public/api-merged.json +++ b/public/api-merged.json @@ -639,6 +639,30 @@ } } }, + "/admin/ldap-sync-status": { + "get": { + "description": "You need to have a permission with action `ldap.status:read`.", + "tags": [ + "ldap_debug" + ], + "summary": "Returns the current state of the LDAP background sync integration.", + "operationId": "getSyncStatus", + "responses": { + "200": { + "$ref": "#/responses/getSyncStatusResponse" + }, + "401": { + "$ref": "#/responses/unauthorisedError" + }, + "403": { + "$ref": "#/responses/forbiddenError" + }, + "500": { + "$ref": "#/responses/internalServerError" + } + } + } + }, "/admin/ldap/reload": { "post": { "security": [ @@ -15142,53 +15166,6 @@ } } }, - "JSONWebKey": { - "type": "object", - "title": "JSONWebKey represents a public or private key in JWK format.", - "properties": { - "Algorithm": { - "description": "Key algorithm, parsed from `alg` header.", - "type": "string" - }, - "CertificateThumbprintSHA1": { - "description": "X.509 certificate thumbprint (SHA-1), parsed from `x5t` header.", - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - }, - "CertificateThumbprintSHA256": { - "description": "X.509 certificate thumbprint (SHA-256), parsed from `x5t#S256` header.", - "type": "array", - "items": { - "type": "integer", - "format": "uint8" - } - }, - "Certificates": { - "description": "X.509 certificate chain, parsed from `x5c` header.", - "type": "array", - "items": { - "$ref": "#/definitions/Certificate" - } - }, - "CertificatesURL": { - "$ref": "#/definitions/URL" - }, - "Key": { - "description": "Cryptographic key, can be a symmetric or asymmetric key." - }, - "KeyID": { - "description": "Key identifier, parsed from `kid` header.", - "type": "string" - }, - "Use": { - "description": "Key use, parsed from `use` header.", - "type": "string" - } - } - }, "Json": { "type": "object" }, @@ -17948,6 +17925,7 @@ "$ref": "#/definitions/Json" }, "folderId": { + "description": "Deprecated: use FolderUID instead", "type": "integer", "format": "int64" }, @@ -18185,6 +18163,10 @@ "type": "boolean", "example": false }, + "isExternal": { + "type": "boolean", + "example": false + }, "login": { "type": "string", "example": "sa-grafana" @@ -18236,6 +18218,10 @@ "type": "boolean", "example": false }, + "isExternal": { + "type": "boolean", + "example": false + }, "login": { "type": "string", "example": "sa-grafana" diff --git a/public/openapi3.json b/public/openapi3.json index d577849398e..61f3dc35912 100644 --- a/public/openapi3.json +++ b/public/openapi3.json @@ -6234,53 +6234,6 @@ "title": "JSONWebKey represents a public or private key in JWK format.", "type": "object" }, - "JSONWebKey": { - "properties": { - "Algorithm": { - "description": "Key algorithm, parsed from `alg` header.", - "type": "string" - }, - "CertificateThumbprintSHA1": { - "description": "X.509 certificate thumbprint (SHA-1), parsed from `x5t` header.", - "items": { - "format": "uint8", - "type": "integer" - }, - "type": "array" - }, - "CertificateThumbprintSHA256": { - "description": "X.509 certificate thumbprint (SHA-256), parsed from `x5t#S256` header.", - "items": { - "format": "uint8", - "type": "integer" - }, - "type": "array" - }, - "Certificates": { - "description": "X.509 certificate chain, parsed from `x5c` header.", - "items": { - "$ref": "#/components/schemas/Certificate" - }, - "type": "array" - }, - "CertificatesURL": { - "$ref": "#/components/schemas/URL" - }, - "Key": { - "description": "Cryptographic key, can be a symmetric or asymmetric key." - }, - "KeyID": { - "description": "Key identifier, parsed from `kid` header.", - "type": "string" - }, - "Use": { - "description": "Key use, parsed from `use` header.", - "type": "string" - } - }, - "title": "JSONWebKey represents a public or private key in JWK format.", - "type": "object" - }, "Json": { "type": "object" }, @@ -9038,6 +8991,7 @@ "$ref": "#/components/schemas/Json" }, "folderId": { + "description": "Deprecated: use FolderUID instead", "format": "int64", "type": "integer" }, @@ -9274,6 +9228,10 @@ "example": false, "type": "boolean" }, + "isExternal": { + "example": false, + "type": "boolean" + }, "login": { "example": "sa-grafana", "type": "string" @@ -9325,6 +9283,10 @@ "example": false, "type": "boolean" }, + "isExternal": { + "example": false, + "type": "boolean" + }, "login": { "example": "sa-grafana", "type": "string" @@ -12528,6 +12490,30 @@ ] } }, + "/admin/ldap-sync-status": { + "get": { + "description": "You need to have a permission with action `ldap.status:read`.", + "operationId": "getSyncStatus", + "responses": { + "200": { + "$ref": "#/components/responses/getSyncStatusResponse" + }, + "401": { + "$ref": "#/components/responses/unauthorisedError" + }, + "403": { + "$ref": "#/components/responses/forbiddenError" + }, + "500": { + "$ref": "#/components/responses/internalServerError" + } + }, + "summary": "Returns the current state of the LDAP background sync integration.", + "tags": [ + "ldap_debug" + ] + } + }, "/admin/ldap/reload": { "post": { "description": "If you are running Grafana Enterprise and have Fine-grained access control enabled, you need to have a permission with action `ldap.config:reload`.",