[Demo][Dashboard] Public create API
#181950
Draft
+185
−1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Dosant
reviewed
Apr 30, 2024
jloleysens
changed the title
create APIcreate API
jloleysens
commented
May 2, 2024
| let result: Dashboard; | ||
| try { | ||
| const cmResult = await client.create(req.body); | ||
| result = cmResult.result as unknown as Dashboard; |
There was a problem hiding this comment.
Seems like there is a gap in the Dashboard type being passed through so I was getting object.
There was a problem hiding this comment.
There was a problem hiding this comment.
To be investigated, in the code it looks like we are forwarding the type in CreateItemResponse<T>
There was a problem hiding this comment.
I think the problem is data: object does not let the return type infer the type of the generic to something other than object
There was a problem hiding this comment.
But here we are talking about the response right? You might be right but it is strange the the input type affects the output type. Although I've seen weirder things with TS 😄
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
A demo showing how with the current code we can get public APIs for dashboards with OpenAPI spec generation.
How to get OAS:
server.oas.enabled: truetokibana.dev.ymlyarn start --no-base-pathcurl -uelastic:changeme http://localhost:5601/api/oas\?pathStartsWith\=/api/dashboard{ "openapi": "3.0.0", "info": { "title": "Kibana HTTP APIs", "version": "0.0.0" }, "servers": [ { "url": "http://localhost:5601" } ], "paths": { "/api/dashboard": { "post": { "requestBody": { "content": { "application/json; Elastic-Api-Version=2023-10-31": { "schema": { "$ref": "#/components/schemas/dashboard.create" } } } }, "responses": { "200": { "description": "Create a dashboard", "content": { "application/json; Elastic-Api-Version=2023-10-31": { "schema": { "$ref": "#/components/schemas/dashboard" } } } } }, "parameters": [ { "in": "header", "name": "elastic-api-version", "schema": { "type": "string", "enum": [ "2023-10-31" ], "default": "2023-10-31" } } ], "operationId": "/api/dashboard#0" } } }, "components": { "schemas": { "dashboard.create": { "type": "object", "properties": { "title": { "description": "A human-readable title for the dashboard", "type": "string" }, "description": { "description": "A short description.", "default": "", "type": "string" }, "kibanaSavedObjectMeta": { "description": "A container for various metadata", "type": "object", "properties": { "searchSourceJSON": { "description": "A string containing search source", "type": "string" } }, "additionalProperties": false, "required": [] }, "timeRestore": { "description": "Whether to restore time upon viewing this dashboard", "type": "boolean" }, "timeFrom": { "description": "An ISO string indicating when to restore time from", "type": "string" }, "timeTo": { "description": "An ISO string indicating when to restore time from", "type": "string" }, "refreshInterval": { "description": "A container for various refresh interval settings", "type": "object", "properties": { "pause": { "description": "Whether the refresh interval is set to be paused while viewing the dashboard.", "type": "boolean" }, "value": { "description": "A numeric value indicating refresh frequency expressed as, for example, 30s.", "type": "number" }, "display": { "description": "Lorem ipsum", "type": "string" }, "section": { "description": "Lorem ipsum", "type": "number" } }, "additionalProperties": false, "required": [ "pause", "value" ] }, "controlGroupInput": { "type": "object", "properties": { "panelsJSON": { "description": "Lorem ipsum", "type": "string" }, "controlStyle": { "description": "Lorem ipsum", "type": "string" }, "chainingSystem": { "description": "Lorem ipsum", "type": "string" }, "ignoreParentSettingsJSON": { "description": "Lorem ipsum", "type": "string" } }, "additionalProperties": false, "required": [] }, "panelsJSON": { "description": "Lorem ipsum", "default": "[]", "type": "string" }, "optionsJSON": { "description": "Lorem ipsum", "default": "{}", "type": "string" }, "id": { "description": "The ID of the dashboard", "type": "string" } }, "additionalProperties": false, "required": [ "title", "kibanaSavedObjectMeta" ] }, "dashboard": { "type": "object", "properties": { "title": { "description": "A human-readable title for the dashboard", "type": "string" }, "description": { "description": "A short description.", "default": "", "type": "string" }, "kibanaSavedObjectMeta": { "description": "A container for various metadata", "type": "object", "properties": { "searchSourceJSON": { "description": "A string containing search source", "type": "string" } }, "additionalProperties": false, "required": [] }, "timeRestore": { "description": "Whether to restore time upon viewing this dashboard", "type": "boolean" }, "timeFrom": { "description": "An ISO string indicating when to restore time from", "type": "string" }, "timeTo": { "description": "An ISO string indicating when to restore time from", "type": "string" }, "refreshInterval": { "description": "A container for various refresh interval settings", "type": "object", "properties": { "pause": { "description": "Whether the refresh interval is set to be paused while viewing the dashboard.", "type": "boolean" }, "value": { "description": "A numeric value indicating refresh frequency expressed as, for example, 30s.", "type": "number" }, "display": { "description": "Lorem ipsum", "type": "string" }, "section": { "description": "Lorem ipsum", "type": "number" } }, "additionalProperties": false, "required": [ "pause", "value" ] }, "controlGroupInput": { "type": "object", "properties": { "panelsJSON": { "description": "Lorem ipsum", "type": "string" }, "controlStyle": { "description": "Lorem ipsum", "type": "string" }, "chainingSystem": { "description": "Lorem ipsum", "type": "string" }, "ignoreParentSettingsJSON": { "description": "Lorem ipsum", "type": "string" } }, "additionalProperties": false, "required": [] }, "panelsJSON": { "description": "Lorem ipsum", "default": "[]", "type": "string" }, "optionsJSON": { "description": "Lorem ipsum", "default": "{}", "type": "string" }, "id": { "description": "The ID of the dashboard", "type": "string" } }, "additionalProperties": false, "required": [ "title", "kibanaSavedObjectMeta", "id" ] } }, "securitySchemes": { "basicAuth": { "type": "http", "scheme": "basic" }, "apiKeyAuth": { "type": "apiKey", "in": "header", "name": "Authorization" } } }, "security": [ { "basicAuth": [] } ] }