github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity

[OAS] Add deprecated saved object APIs (#164355)

Browse source
This commit is contained in:
Lisa Cawley 2023-08-25 12:48:55 -07:00 • committed by GitHub
parent c115f5d3d6
commit 16f7189bb1
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
35 changed files with 2028 additions and 46 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/api/saved-objects/bulk_create.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Create multiple {kib} saved objects.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-bulk-create-request]]
==== Request

6
docs/api/saved-objects/bulk_delete.asciidoc
View file

@ -10,6 +10,12 @@ Remove multiple {kib} saved objects.
WARNING: Once you delete a saved object, _it cannot be recovered_.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
==== Request
`POST <kibana host>:<port>/api/saved_objects/_bulk_delete`

6
docs/api/saved-objects/bulk_get.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Retrieve multiple {kib} saved objects by ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-bulk-get-request]]
==== Request

6
docs/api/saved-objects/bulk_resolve.asciidoc
View file

@ -12,6 +12,12 @@ Under certain circumstances, when Kibana is upgraded, saved object migrations ma
features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that
object can be retrieved via the Bulk Resolve API using either its new ID or its old ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-bulk-resolve-request]]
==== Request

6
docs/api/saved-objects/bulk_update.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Update the attributes for multiple existing {kib} saved objects.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-bulk-update-request]]
==== Request

6
docs/api/saved-objects/create.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Create {kib} saved objects.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-create-request]]
==== Request

6
docs/api/saved-objects/delete.asciidoc
View file

@ -10,6 +10,12 @@ Remove {kib} saved objects.
WARNING: Once you delete a saved object, _it cannot be recovered_.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-delete-request]]
==== Request

6
docs/api/saved-objects/find.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Retrieve a paginated set of {kib} saved objects by various conditions.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-find-request]]
==== Request

6
docs/api/saved-objects/get.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Retrieve a single {kib} saved object by ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-get-request]]
==== Request

6
docs/api/saved-objects/resolve.asciidoc
View file

@ -12,6 +12,12 @@ Under certain circumstances, when Kibana is upgraded, saved object migrations ma
features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that
object can be retrieved via the Resolve API using either its new ID or its old ID.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-resolve-request]]
==== Request

6
docs/api/saved-objects/resolve_import_errors.asciidoc
View file

@ -14,6 +14,12 @@ To resolve errors, you can:
* Change references to different saved objects
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-resolve-import-errors-request]]
==== Request

6
docs/api/saved-objects/rotate_encryption_key.asciidoc
View file

@ -7,6 +7,12 @@
experimental[] Rotate the encryption key for encrypted saved objects.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
If a saved object cannot be decrypted using the primary encryption key, then {kib} will attempt to decrypt it using the specified <<xpack-encryptedSavedObjects-keyRotation-decryptionOnlyKeys, decryption-only keys>>. In most of the cases this overhead is negligible, but if you're dealing with a large number of saved objects and experiencing performance issues, you may want to rotate the encryption key.
[IMPORTANT]

6
docs/api/saved-objects/update.asciidoc
View file

@ -8,6 +8,12 @@ deprecated::[8.7.0, To be removed in an upcoming version]
Update the attributes for existing {kib} saved objects.
[NOTE]
====
For the most up-to-date API details, refer to the
{kib-repo}/tree/{branch}/packages/core/saved-objects/docs/openapi[open API specification].
====
[[saved-objects-api-update-request]]
==== Request

880
packages/core/saved-objects/docs/openapi/bundled.json
View file

@ -93,12 +93,11 @@
}
},
"400": {
"description": "Bad request.",
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/components/schemas/400_response"
}
}
}
@ -126,6 +125,324 @@
}
]
},
"/api/saved_objects/_bulk_create": {
"post": {
"summary": "Create multiple Kibana saved objects.",
"operationId": "bulkCreateSavedObjects",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"in": "query",
"name": "overwrite",
"description": "When true, overwrites the document with the same identifier.",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_bulk_delete": {
"post": {
"summary": "Remove multiple Kibana saved objects.",
"operationId": "bulkDeleteSavedObjects",
"description": "WARNING: When you delete a saved object, it cannot be recovered.\n",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"in": "query",
"name": "force",
"description": "When true, force delete objects that exist in multiple namespaces. Note that the option applies to the whole request. Use the delete object API to specify per-object deletion behavior. TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: \"Unable to delete saved object that exists in multiple namespaces, use the force option to delete it anyway\". WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes legacy url aliases that reference the object. These requests are batched to minimise the impact but they can place a heavy load on Kibana. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete operation.\n",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.\n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_bulk_get": {
"post": {
"summary": "Retrieve multiple Kibana saved objects by identifier.",
"operationId": "bulkGetSavedObjects",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_bulk_resolve": {
"post": {
"summary": "Retrieve multiple Kibana saved objects by identifier using any legacy URL aliases if they exist.",
"operationId": "bulkResolveSavedObjects",
"deprecated": true,
"description": "Under certain circumstances when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved by the bulk resolve API using either its new ID or its old ID.\n",
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body. \n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_bulk_update": {
"post": {
"summary": "Update the attributes for multiple Kibana saved objects.",
"operationId": "bulkUpdateSavedObjects",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body. \n",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_export": {
"post": {
"summary": "Retrieve sets of saved objects that you want to import into Kibana.",
@ -208,8 +525,185 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/_find": {
"get": {
"summary": "Retrieve a paginated set of Kibana saved objects.",
"operationId": "findSavedObjects",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"in": "query",
"name": "aggs",
"description": "An aggregation structure, serialized as a string. The field format is similar to filter, meaning that to use a saved object type attribute in the aggregation, the `savedObjectType.attributes.title: \"myTitle\"` format must be used. For root fields, the syntax is `savedObjectType.rootField`. NOTE: As objects change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.\n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "default_search_operator",
"description": "The default operator to use for the `simple_query_string`.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "fields",
"description": "The fields to return in the attributes key of the response.",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array"
}
]
}
},
{
"in": "query",
"name": "filter",
"description": "The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type, it should look like that: `savedObjectType.attributes.title: \"myTitle\"`. However, if you use a root attribute of a saved object such as `updated_at`, you will have to define your filter like that: `savedObjectType.updated_at > 2018-12-22`.\n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "has_no_reference",
"description": "Filters to objects that do not have a relationship with the type and identifier combination.",
"schema": {
"type": "object"
}
},
{
"in": "query",
"name": "has_no_reference_operator",
"description": "The operator to use for the `has_no_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "has_reference",
"description": "Filters to objects that have a relationship with the type and ID combination.",
"schema": {
"type": "object"
}
},
{
"in": "query",
"name": "has_reference_operator",
"description": "The operator to use for the `has_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "page",
"description": "The page of objects to return.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "per_page",
"description": "The number of objects to return per page.",
"schema": {
"type": "integer"
}
},
{
"in": "query",
"name": "search",
"description": "An Elasticsearch `simple_query_string` query that filters the objects in the response.",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "search_fields",
"description": "The fields to perform the `simple_query_string` parsed query against.",
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array"
}
]
}
},
{
"in": "query",
"name": "sort_field",
"description": "Sorts the response. Includes \"root\" and \"type\" fields. \"root\" fields exist for all saved objects, such as \"updated_at\". \"type\" fields are specific to an object type, such as fields returned in the attributes key of the response. When a single type is defined in the type parameter, the \"root\" and \"type\" fields are allowed, and validity checks are made in that order. When multiple types are defined in the type parameter, only \"root\" fields are allowed.\n",
"schema": {
"type": "string"
}
},
{
"in": "query",
"name": "type",
"description": "The saved object types to include.",
"required": true,
"schema": {
"oneOf": [
{
"type": "string"
},
{
"type": "array"
}
]
}
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
@ -332,8 +826,7 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/components/schemas/400_response"
}
}
}
@ -503,8 +996,319 @@
"content": {
"application/json": {
"schema": {
"type": "object",
"additionalProperties": true
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/{type}": {
"post": {
"summary": "Create Kibana saved objects with randomly generated identifiers.",
"operationId": "createSavedObject",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/saved_object_type"
},
{
"in": "query",
"name": "overwrite",
"description": "If true, overwrites the document with the same identifier.",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"$ref": "#/components/schemas/attributes"
},
"initialNamespaces": {
"$ref": "#/components/schemas/initial_namespaces"
},
"references": {
"$ref": "#/components/schemas/references"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"409": {
"description": "Indicates a conflict error.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/{type}/{id}": {
"get": {
"summary": "Retrieve a single Kibana saved object by identifier.",
"operationId": "getSavedObject",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/saved_object_id"
},
{
"$ref": "#/components/parameters/saved_object_type"
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"post": {
"summary": "Create Kibana saved objects.",
"operationId": "createSavedObjectId",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/saved_object_id"
},
{
"$ref": "#/components/parameters/saved_object_type"
},
{
"in": "query",
"name": "overwrite",
"description": "If true, overwrites the document with the same identifier.",
"schema": {
"type": "boolean"
}
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"attributes"
],
"properties": {
"attributes": {
"$ref": "#/components/schemas/attributes"
},
"initialNamespaces": {
"$ref": "#/components/schemas/initial_namespaces"
},
"references": {
"$ref": "#/components/schemas/initial_namespaces"
}
}
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"409": {
"description": "Indicates a conflict error.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"put": {
"summary": "Update the attributes for Kibana saved objects.",
"operationId": "updateSavedObject",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
},
{
"$ref": "#/components/parameters/saved_object_id"
},
{
"$ref": "#/components/parameters/saved_object_type"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"404": {
"description": "Indicates the object was not found.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"409": {
"description": "Indicates a conflict error.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
}
}
},
"servers": [
{
"url": "https://localhost:5601"
}
]
},
"/api/saved_objects/resolve/{type}/{id}": {
"get": {
"summary": "Retrieve a single Kibana saved object by identifier using any legacy URL alias if it exists.",
"operationId": "resolveSavedObject",
"description": "Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved using either its new ID or its old ID.\n",
"deprecated": true,
"tags": [
"saved objects"
],
"parameters": [
{
"$ref": "#/components/parameters/saved_object_id"
},
{
"$ref": "#/components/parameters/saved_object_type"
}
],
"responses": {
"200": {
"description": "Indicates a successful call.",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"400": {
"description": "Bad request.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/400_response"
}
}
}
@ -680,6 +1484,46 @@
}
}
},
"schemas": {
"400_response": {
"title": "Bad request",
"type": "object",
"required": [
"error",
"message",
"statusCode"
],
"properties": {
"error": {
"type": "string",
"enum": [
"Bad Request"
]
},
"message": {
"type": "string"
},
"statusCode": {
"type": "integer",
"enum": [
400
]
}
}
},
"attributes": {
"type": "object",
"description": "The data that you want to create. WARNING: When you create saved objects, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.\n"
},
"initial_namespaces": {
"type": "array",
"description": "Identifiers for the spaces in which this object is created. If this is provided, the object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space (default behavior). For shareable object types (registered with `namespaceType: 'multiple'`), this option can be used to specify one or more spaces, including the \"All spaces\" identifier ('*'). For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`), this option can only be used to specify a single space, and the \"All spaces\" identifier ('*') is not allowed. For global object types (`registered with `namespaceType: agnostic`), this option cannot be used.\n"
},
"references": {
"type": "array",
"description": "Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references. Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import and export.\n"
}
},
"parameters": {
"kbn_xsrf": {
"schema": {
@ -689,6 +1533,24 @@
"name": "kbn-xsrf",
"description": "Cross-site request forgery protection",
"required": true
},
"saved_object_type": {
"in": "path",
"name": "type",
"description": "Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`.",
"required": true,
"schema": {
"type": "string"
}
},
"saved_object_id": {
"in": "path",
"name": "id",
"description": "An identifier for the saved object.",
"required": true,
"schema": {
"type": "string"
}
}
}
}

527
packages/core/saved-objects/docs/openapi/bundled.yaml
View file

@ -72,12 +72,11 @@ paths:
rotateEncryptionKeyResponse:
$ref: '#/components/examples/key_rotation_response'
'400':
description: Bad request.
description: Bad request
content:
application/json:
schema:
type: object
additionalProperties: true
$ref: '#/components/schemas/400_response'
'429':
description: Already in progress.
content:
@ -88,6 +87,194 @@ paths:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_bulk_create:
post:
summary: Create multiple Kibana saved objects.
operationId: bulkCreateSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- in: query
name: overwrite
description: When true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_bulk_delete:
post:
summary: Remove multiple Kibana saved objects.
operationId: bulkDeleteSavedObjects
description: |
WARNING: When you delete a saved object, it cannot be recovered.
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- in: query
name: force
description: |
When true, force delete objects that exist in multiple namespaces. Note that the option applies to the whole request. Use the delete object API to specify per-object deletion behavior. TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: "Unable to delete saved object that exists in multiple namespaces, use the force option to delete it anyway". WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes legacy url aliases that reference the object. These requests are batched to minimise the impact but they can place a heavy load on Kibana. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete operation.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_bulk_get:
post:
summary: Retrieve multiple Kibana saved objects by identifier.
operationId: bulkGetSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_bulk_resolve:
post:
summary: Retrieve multiple Kibana saved objects by identifier using any legacy URL aliases if they exist.
operationId: bulkResolveSavedObjects
deprecated: true
description: |
Under certain circumstances when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved by the bulk resolve API using either its new ID or its old ID.
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_bulk_update:
post:
summary: Update the attributes for multiple Kibana saved objects.
operationId: bulkUpdateSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: |
Indicates a successful call. NOTE: This HTTP response code indicates that the bulk operation succeeded. Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_export:
post:
summary: Retrieve sets of saved objects that you want to import into Kibana.
@ -145,11 +332,115 @@ paths:
$ref: '#/components/examples/export_objects_response'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/_find:
get:
summary: Retrieve a paginated set of Kibana saved objects.
operationId: findSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- in: query
name: aggs
description: |
An aggregation structure, serialized as a string. The field format is similar to filter, meaning that to use a saved object type attribute in the aggregation, the `savedObjectType.attributes.title: "myTitle"` format must be used. For root fields, the syntax is `savedObjectType.rootField`. NOTE: As objects change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
schema:
type: string
- in: query
name: default_search_operator
description: The default operator to use for the `simple_query_string`.
schema:
type: string
- in: query
name: fields
description: The fields to return in the attributes key of the response.
schema:
oneOf:
- type: string
- type: array
- in: query
name: filter
description: |
The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type, it should look like that: `savedObjectType.attributes.title: "myTitle"`. However, if you use a root attribute of a saved object such as `updated_at`, you will have to define your filter like that: `savedObjectType.updated_at > 2018-12-22`.
schema:
type: string
- in: query
name: has_no_reference
description: Filters to objects that do not have a relationship with the type and identifier combination.
schema:
type: object
- in: query
name: has_no_reference_operator
description: The operator to use for the `has_no_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
schema:
type: string
- in: query
name: has_reference
description: Filters to objects that have a relationship with the type and ID combination.
schema:
type: object
- in: query
name: has_reference_operator
description: The operator to use for the `has_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
schema:
type: string
- in: query
name: page
description: The page of objects to return.
schema:
type: integer
- in: query
name: per_page
description: The number of objects to return per page.
schema:
type: integer
- in: query
name: search
description: An Elasticsearch `simple_query_string` query that filters the objects in the response.
schema:
type: string
- in: query
name: search_fields
description: The fields to perform the `simple_query_string` parsed query against.
schema:
oneOf:
- type: string
- type: array
- in: query
name: sort_field
description: |
Sorts the response. Includes "root" and "type" fields. "root" fields exist for all saved objects, such as "updated_at". "type" fields are specific to an object type, such as fields returned in the attributes key of the response. When a single type is defined in the type parameter, the "root" and "type" fields are allowed, and validity checks are made in that order. When multiple types are defined in the type parameter, only "root" fields are allowed.
schema:
type: string
- in: query
name: type
description: The saved object types to include.
required: true
schema:
oneOf:
- type: string
- type: array
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
additionalProperties: true
'400':
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
@ -239,8 +530,7 @@ paths:
content:
application/json:
schema:
type: object
additionalProperties: true
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
@ -364,11 +654,189 @@ paths:
$ref: '#/components/examples/resolve_missing_reference_response'
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601
/api/saved_objects/{type}:
post:
summary: Create Kibana saved objects with randomly generated identifiers.
operationId: createSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/saved_object_type'
- in: query
name: overwrite
description: If true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- attributes
properties:
attributes:
$ref: '#/components/schemas/attributes'
initialNamespaces:
$ref: '#/components/schemas/initial_namespaces'
references:
$ref: '#/components/schemas/references'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
additionalProperties: true
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
servers:
- url: https://localhost:5601
/api/saved_objects/{type}/{id}:
get:
summary: Retrieve a single Kibana saved object by identifier.
operationId: getSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/saved_object_id'
- $ref: '#/components/parameters/saved_object_type'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
post:
summary: Create Kibana saved objects.
operationId: createSavedObjectId
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/saved_object_id'
- $ref: '#/components/parameters/saved_object_type'
- in: query
name: overwrite
description: If true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- attributes
properties:
attributes:
$ref: '#/components/schemas/attributes'
initialNamespaces:
$ref: '#/components/schemas/initial_namespaces'
references:
$ref: '#/components/schemas/initial_namespaces'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
put:
summary: Update the attributes for Kibana saved objects.
operationId: updateSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/kbn_xsrf'
- $ref: '#/components/parameters/saved_object_id'
- $ref: '#/components/parameters/saved_object_type'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'404':
description: Indicates the object was not found.
content:
application/json:
schema:
type: object
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
servers:
- url: https://localhost:5601
/api/saved_objects/resolve/{type}/{id}:
get:
summary: Retrieve a single Kibana saved object by identifier using any legacy URL alias if it exists.
operationId: resolveSavedObject
description: |
Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features. When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID. In such a scenario, that object can be retrieved using either its new ID or its old ID.
deprecated: true
tags:
- saved objects
parameters:
- $ref: '#/components/parameters/saved_object_id'
- $ref: '#/components/parameters/saved_object_type'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '#/components/schemas/400_response'
servers:
- url: https://localhost:5601
servers:
@ -478,6 +946,37 @@ components:
meta:
icon: dashboardApp
title: Look at my dashboard
schemas:
400_response:
title: Bad request
type: object
required:
- error
- message
- statusCode
properties:
error:
type: string
enum:
- Bad Request
message:
type: string
statusCode:
type: integer
enum:
- 400
attributes:
type: object
description: |
The data that you want to create. WARNING: When you create saved objects, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.
initial_namespaces:
type: array
description: |
Identifiers for the spaces in which this object is created. If this is provided, the object is created only in the explicitly defined spaces. If this is not provided, the object is created in the current space (default behavior). For shareable object types (registered with `namespaceType: 'multiple'`), this option can be used to specify one or more spaces, including the "All spaces" identifier ('*'). For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`), this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed. For global object types (`registered with `namespaceType: agnostic`), this option cannot be used.
references:
type: array
description: |
Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references. Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import and export.
parameters:
kbn_xsrf:
schema:
@ -486,3 +985,17 @@ components:
name: kbn-xsrf
description: Cross-site request forgery protection
required: true
saved_object_type:
in: path
name: type
description: Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`.
required: true
schema:
type: string
saved_object_id:
in: path
name: id
description: An identifier for the saved object.
required: true
schema:
type: string

6
packages/core/saved-objects/docs/openapi/components/parameters/saved_object_id.yaml Normal file
View file

@ -0,0 +1,6 @@
in: path
name: id
description: An identifier for the saved object.
required: true
schema:
type: string

6
packages/core/saved-objects/docs/openapi/components/parameters/saved_object_type.yaml Normal file
View file

@ -0,0 +1,6 @@
in: path
name: type
description: Valid options include `visualization`, `dashboard`, `search`, `index-pattern`, `config`.
required: true
schema:
type: string

17
packages/core/saved-objects/docs/openapi/components/schemas/400_response.yaml Normal file
View file

@ -0,0 +1,17 @@
title: Bad request
type: object
required:
- error
- message
- statusCode
properties:
error:
type: string
enum:
- Bad Request
message:
type: string
statusCode:
type: integer
enum:
- 400

4
packages/core/saved-objects/docs/openapi/components/schemas/attributes.yaml Normal file
View file

@ -0,0 +1,4 @@
type: object
description: >
The data that you want to create.
WARNING: When you create saved objects, attributes are not validated, which allows you to pass arbitrary and ill-formed data into the API that can break Kibana. Make sure any data that you send to the API is properly formed.

8
packages/core/saved-objects/docs/openapi/components/schemas/initial_namespaces.yaml Normal file
View file

@ -0,0 +1,8 @@
type: array
description: >
Identifiers for the spaces in which this object is created.
If this is provided, the object is created only in the explicitly defined spaces.
If this is not provided, the object is created in the current space (default behavior).
For shareable object types (registered with `namespaceType: 'multiple'`), this option can be used to specify one or more spaces, including the "All spaces" identifier ('*').
For isolated object types (registered with `namespaceType: 'single'` or `namespaceType: 'multiple-isolated'`), this option can only be used to specify a single space, and the "All spaces" identifier ('*') is not allowed.
For global object types (`registered with `namespaceType: agnostic`), this option cannot be used.

4
packages/core/saved-objects/docs/openapi/components/schemas/references.yaml Normal file
View file

@ -0,0 +1,4 @@
type: array
description: >
Objects with `name`, `id`, and `type` properties that describe the other saved objects that this object references.
Use `name` in attributes to refer to the other saved object, but never the `id`, which can update automatically during migrations or import and export.

36
packages/core/saved-objects/docs/openapi/entrypoint.yaml
View file

@ -18,30 +18,30 @@ paths:
# Paths in the default space
'/api/encrypted_saved_objects/_rotate_key':
$ref: 'paths/api@encrypted_saved_objects@_rotate_key.yaml'
# '/api/saved_objects/_bulk_create':
# $ref: 'paths/api@saved_objects@_bulk_create.yaml'
# '/api/saved_objects/_bulk_delete':
# $ref: 'paths/api@saved_objects@_bulk_delete.yaml'
# '/api/saved_objects/_bulk_get':
# $ref: 'paths/api@saved_objects@_bulk_get.yaml'
# '/api/saved_objects/_bulk_resolve':
# $ref: 'paths/api@saved_objects@_bulk_resolve.yaml'
# '/api/saved_objects/_bulk_update':
# $ref: 'paths/api@saved_objects@_bulk_update.yaml'
'/api/saved_objects/_bulk_create':
$ref: 'paths/api@saved_objects@_bulk_create.yaml'
'/api/saved_objects/_bulk_delete':
$ref: 'paths/api@saved_objects@_bulk_delete.yaml'
'/api/saved_objects/_bulk_get':
$ref: 'paths/api@saved_objects@_bulk_get.yaml'
'/api/saved_objects/_bulk_resolve':
$ref: 'paths/api@saved_objects@_bulk_resolve.yaml'
'/api/saved_objects/_bulk_update':
$ref: 'paths/api@saved_objects@_bulk_update.yaml'
'/api/saved_objects/_export':
$ref: 'paths/api@saved_objects@_export.yaml'
# '/api/saved_objects/_find':
# $ref: 'paths/api@saved_objects@_find.yaml'
'/api/saved_objects/_find':
$ref: 'paths/api@saved_objects@_find.yaml'
'/api/saved_objects/_import':
$ref: 'paths/api@saved_objects@_import.yaml'
'/api/saved_objects/_resolve_import_errors':
$ref: 'paths/api@saved_objects@_resolve_import_errors.yaml'
# '/api/saved_objects/{type}':
# $ref: 'paths/api@saved_objects@{type}.yaml'
# '/api/saved_objects/{type}/{id}':
# $ref: 'paths/api@saved_objects@{type}@{id}.yaml
# 'api/saved_objects/resolve/{type}/{id}':
# $ref: 'paths/api@saved_objects@resolve@{type}@{id}.yaml'
'/api/saved_objects/{type}':
$ref: 'paths/api@saved_objects@{type}.yaml'
'/api/saved_objects/{type}/{id}':
$ref: 'paths/api@saved_objects@{type}@{id}.yaml'
'/api/saved_objects/resolve/{type}/{id}':
$ref: 'paths/api@saved_objects@resolve@{type}@{id}.yaml'
components:
securitySchemes:
basicAuth:

11
packages/core/saved-objects/docs/openapi/paths/api@encrypted_saved_objects@_rotate_key.yaml
View file

@ -51,12 +51,11 @@ post:
rotateEncryptionKeyResponse:
$ref: '../components/examples/key_rotation_response.yaml'
'400':
description: Bad request.
content:
application/json:
schema:
type: object
additionalProperties: true
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
'429':
description: Already in progress.
content:

39
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_bulk_create.yaml Normal file
View file

@ -0,0 +1,39 @@
post:
summary: Create multiple Kibana saved objects.
operationId: bulkCreateSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
- in: query
name: overwrite
description: When true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

48
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_bulk_delete.yaml Normal file
View file

@ -0,0 +1,48 @@
post:
summary: Remove multiple Kibana saved objects.
operationId: bulkDeleteSavedObjects
description: >
WARNING: When you delete a saved object, it cannot be recovered.
deprecated: true
tags:
- saved objects
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
- in: query
name: force
description: >
When true, force delete objects that exist in multiple namespaces.
Note that the option applies to the whole request.
Use the delete object API to specify per-object deletion behavior.
TIP: Use this if you attempted to delete objects and received an HTTP 400 error with the following message: "Unable to delete saved object that exists in multiple namespaces, use the force option to delete it anyway".
WARNING: When you bulk delete objects that exist in multiple namespaces, the API also deletes legacy url aliases that reference the object. These requests are batched to minimise the impact but they can place a heavy load on Kibana. Make sure you limit the number of objects that exist in multiple namespaces in a single bulk delete operation.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: >
Indicates a successful call.
NOTE: This HTTP response code indicates that the bulk operation succeeded.
Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

33
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_bulk_get.yaml Normal file
View file

@ -0,0 +1,33 @@
post:
summary: Retrieve multiple Kibana saved objects by identifier.
operationId: bulkGetSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

40
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_bulk_resolve.yaml Normal file
View file

@ -0,0 +1,40 @@
post:
summary: Retrieve multiple Kibana saved objects by identifier using any legacy URL aliases if they exist.
operationId: bulkResolveSavedObjects
deprecated: true
description: >
Under certain circumstances when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features.
When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID.
In such a scenario, that object can be retrieved by the bulk resolve API using either its new ID or its old ID.
tags:
- saved objects
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: >
Indicates a successful call.
NOTE: This HTTP response code indicates that the bulk operation succeeded.
Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

36
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_bulk_update.yaml Normal file
View file

@ -0,0 +1,36 @@
post:
summary: Update the attributes for multiple Kibana saved objects.
operationId: bulkUpdateSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- $ref: ../components/headers/kbn_xsrf.yaml
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
type: object
responses:
'200':
description: >
Indicates a successful call.
NOTE: This HTTP response code indicates that the bulk operation succeeded.
Errors pertaining to individual objects will be returned in the response body.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

3
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_export.yaml
View file

@ -57,8 +57,7 @@ post:
content:
application/json:
schema:
type: object
additionalProperties: true
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:

111
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_find.yaml Normal file
View file

@ -0,0 +1,111 @@
get:
summary: Retrieve a paginated set of Kibana saved objects.
operationId: findSavedObjects
deprecated: true
tags:
- saved objects
parameters:
- in: query
name: aggs
description: >
An aggregation structure, serialized as a string. The field format is similar to filter, meaning that to use a saved object type attribute in the aggregation, the `savedObjectType.attributes.title: "myTitle"` format must be used. For root fields, the syntax is `savedObjectType.rootField`.
NOTE: As objects change in Kibana, the results on each page of the response also change. Use the find API for traditional paginated results, but avoid using it to export large amounts of data.
schema:
type: string
- in: query
name: default_search_operator
description: The default operator to use for the `simple_query_string`.
schema:
type: string
- in: query
name: fields
description: The fields to return in the attributes key of the response.
schema:
oneOf:
- type: string
- type: array
- in: query
name: filter
description: >
The filter is a KQL string with the caveat that if you filter with an attribute from your saved object type, it should look like that: `savedObjectType.attributes.title: "myTitle"`.
However, if you use a root attribute of a saved object such as `updated_at`, you will have to define your filter like that: `savedObjectType.updated_at > 2018-12-22`.
schema:
type: string
- in: query
name: has_no_reference
description: Filters to objects that do not have a relationship with the type and identifier combination.
schema:
type: object
- in: query
name: has_no_reference_operator
description: The operator to use for the `has_no_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
schema:
type: string
- in: query
name: has_reference
description: Filters to objects that have a relationship with the type and ID combination.
schema:
type: object
- in: query
name: has_reference_operator
description: The operator to use for the `has_reference` parameter. Either `OR` or `AND`. Defaults to `OR`.
schema:
type: string
- in: query
name: page
description: The page of objects to return.
schema:
type: integer
- in: query
name: per_page
description: The number of objects to return per page.
schema:
type: integer
- in: query
name: search
description: An Elasticsearch `simple_query_string` query that filters the objects in the response.
schema:
type: string
- in: query
name: search_fields
description: The fields to perform the `simple_query_string` parsed query against.
schema:
oneOf:
- type: string
- type: array
- in: query
name: sort_field
description: >
Sorts the response.
Includes "root" and "type" fields.
"root" fields exist for all saved objects, such as "updated_at".
"type" fields are specific to an object type, such as fields returned in the attributes key of the response.
When a single type is defined in the type parameter, the "root" and "type" fields are allowed, and validity checks are made in that order.
When multiple types are defined in the type parameter, only "root" fields are allowed.
schema:
type: string
- in: query
name: type
description: The saved object types to include.
required: true
schema:
oneOf:
- type: string
- type: array
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

3
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_import.yaml
View file

@ -82,8 +82,7 @@ post:
content:
application/json:
schema:
type: object
additionalProperties: true
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:

3
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@_resolve_import_errors.yaml
View file

@ -119,8 +119,7 @@ post:
content:
application/json:
schema:
type: object
additionalProperties: true
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:

31
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@resolve@{type}@{id}.yaml Normal file
View file

@ -0,0 +1,31 @@
get:
summary: Retrieve a single Kibana saved object by identifier using any legacy URL alias if it exists.
operationId: resolveSavedObject
description: >
Under certain circumstances, when Kibana is upgraded, saved object migrations may necessitate regenerating some object IDs to enable new features.
When an object's ID is regenerated, a legacy URL alias is created for that object, preserving its old ID.
In such a scenario, that object can be retrieved using either its new ID or its old ID.
deprecated: true
tags:
- saved objects
parameters:
- $ref: '../components/parameters/saved_object_id.yaml'
- $ref: '../components/parameters/saved_object_type.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
servers:
- url: https://localhost:5601

44
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@{type}.yaml Normal file
View file

@ -0,0 +1,44 @@
post:
summary: Create Kibana saved objects with randomly generated identifiers.
operationId: createSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/saved_object_type.yaml'
- in: query
name: overwrite
description: If true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- attributes
properties:
attributes:
$ref: '../components/schemas/attributes.yaml'
initialNamespaces:
$ref: '../components/schemas/initial_namespaces.yaml'
references:
$ref: '../components/schemas/references.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
servers:
- url: https://localhost:5601

106
packages/core/saved-objects/docs/openapi/paths/api@saved_objects@{type}@{id}.yaml Normal file
View file

@ -0,0 +1,106 @@
get:
summary: Retrieve a single Kibana saved object by identifier.
operationId: getSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '../components/parameters/saved_object_id.yaml'
- $ref: '../components/parameters/saved_object_type.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'400':
description: Bad request.
content:
application/json:
schema:
$ref: '../components/schemas/400_response.yaml'
servers:
- url: https://localhost:5601
post:
summary: Create Kibana saved objects.
operationId: createSavedObjectId
deprecated: true
tags:
- saved objects
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/saved_object_id.yaml'
- $ref: '../components/parameters/saved_object_type.yaml'
- in: query
name: overwrite
description: If true, overwrites the document with the same identifier.
schema:
type: boolean
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- attributes
properties:
attributes:
$ref: '../components/schemas/attributes.yaml'
initialNamespaces:
$ref: '../components/schemas/initial_namespaces.yaml'
references:
$ref: '../components/schemas/initial_namespaces.yaml'
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
put:
summary: Update the attributes for Kibana saved objects.
operationId: updateSavedObject
deprecated: true
tags:
- saved objects
parameters:
- $ref: '../components/headers/kbn_xsrf.yaml'
- $ref: '../components/parameters/saved_object_id.yaml'
- $ref: '../components/parameters/saved_object_type.yaml'
requestBody:
required: true
content:
application/json:
schema:
type: object
responses:
'200':
description: Indicates a successful call.
content:
application/json:
schema:
type: object
'404':
description: Indicates the object was not found.
content:
application/json:
schema:
type: object
'409':
description: Indicates a conflict error.
content:
application/json:
schema:
type: object
servers:
- url: https://localhost:5601