Skip to content

Commit

Permalink
[DOCS] Edit get tags API
Browse files Browse the repository at this point in the history
This API reference page mentions a path parameter that seems to be invalid.  This PR fixes that section as well as some other phrases to align with other case APIs.
  • Loading branch information
lcawl authored Apr 11, 2022
1 parent eeee6b9 commit ef3efe5
Showing 1 changed file with 4 additions and 12 deletions.
16 changes: 4 additions & 12 deletions docs/api/cases/cases-api-get-tags.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
<titleabbrev>Get tags</titleabbrev>
++++

Aggregates and returns all unique tags from all cases.
Aggregates and returns a list of case tags.

=== Request

Expand All @@ -21,20 +21,14 @@ You must have `read` privileges for the *Cases* feature in the *Management*,

=== Path parameters

`<case_id>`::
(Required, string) An identifier for the case to retrieve. Use
<<cases-api-find-cases>> to retrieve case IDs.

`<space_id>`::
(Optional, string) An identifier for the space. If it is not specified, the
default space is used.

=== Query parameters

`owner`::
(Optional, string) Specifies the set of applications to limit the retrieved
tags. If not specified, the response contains all tags that the user has access
to read.
(Optional, string or array of strings) A filter to limit the retrieved tags to a specific set of applications. Valid values are: `cases`, `observability`, and `securitySolution`. If this parameter is omitted, the response contains tags from all cases that the user has access to read.

==== Response code

Expand All @@ -43,15 +37,13 @@ to read.

==== Example

Gets all tags for all cases:

[source,sh]
--------------------------------------------------
GET api/cases/tags
--------------------------------------------------
// KIBANA

The API returns a JSON object with all tags for all cases. For example:
The API returns a JSON object with tags from all the cases that the user has access to read. For example:

[source,json]
--------------------------------------------------
Expand All @@ -61,4 +53,4 @@ The API returns a JSON object with all tags for all cases. For example:
"social engineering",
"bubblegum"
]
--------------------------------------------------
--------------------------------------------------

0 comments on commit ef3efe5

Please sign in to comment.