Skip to content

Commit

Permalink
Add API descriptions and availability
Browse files Browse the repository at this point in the history
  • Loading branch information
@lcawl
lcawl committed Nov 14, 2024
1 parent dfe1981 commit b3a6fd7
Show file tree
Hide file tree
Showing 5 changed files with 143 additions and 48 deletions.
29 changes: 20 additions & 9 deletions oas_docs/bundle.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5662,6 +5662,7 @@
}
},
{
"description": "The page number to return.",
"in": "query",
"name": "page",
"required": false,
Expand All @@ -5671,6 +5672,7 @@
}
},
{
"description": "The number of dashboards to display on each page.",
"in": "query",
"name": "perPage",
"required": false,
Expand Down Expand Up @@ -5819,10 +5821,11 @@
}
}
},
"summary": "Get a list of dashboards.",
"summary": "Get a list of dashboards",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
}
},
"/api/dashboards/dashboard/{id}": {
Expand Down Expand Up @@ -5853,6 +5856,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand All @@ -5862,10 +5866,11 @@
}
],
"responses": {},
"summary": "Delete a dashboard.",
"summary": "Delete a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"get": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand All @@ -5884,6 +5889,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand Down Expand Up @@ -6520,10 +6526,11 @@
}
}
},
"summary": "Get a dashboard.",
"summary": "Get a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"post": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand Down Expand Up @@ -6552,6 +6559,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": false,
Expand Down Expand Up @@ -7697,7 +7705,8 @@
"summary": "Create a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"put": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand Down Expand Up @@ -7726,6 +7735,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand Down Expand Up @@ -8862,10 +8872,11 @@
}
}
},
"summary": "Update an existing dashboard.",
"summary": "Update an existing dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
}
},
"/api/fleet/agent_download_sources": {
Expand Down
29 changes: 20 additions & 9 deletions oas_docs/bundle.serverless.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5662,6 +5662,7 @@
}
},
{
"description": "The page number to return.",
"in": "query",
"name": "page",
"required": false,
Expand All @@ -5671,6 +5672,7 @@
}
},
{
"description": "The number of dashboards to display on each page.",
"in": "query",
"name": "perPage",
"required": false,
Expand Down Expand Up @@ -5819,10 +5821,11 @@
}
}
},
"summary": "Get a list of dashboards.",
"summary": "Get a list of dashboards",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
}
},
"/api/dashboards/dashboard/{id}": {
Expand Down Expand Up @@ -5853,6 +5856,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand All @@ -5862,10 +5866,11 @@
}
],
"responses": {},
"summary": "Delete a dashboard.",
"summary": "Delete a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"get": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand All @@ -5884,6 +5889,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand Down Expand Up @@ -6520,10 +6526,11 @@
}
}
},
"summary": "Get a dashboard.",
"summary": "Get a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"post": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand Down Expand Up @@ -6552,6 +6559,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": false,
Expand Down Expand Up @@ -7697,7 +7705,8 @@
"summary": "Create a dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
},
"put": {
"description": "This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.",
Expand Down Expand Up @@ -7726,6 +7735,7 @@
}
},
{
"description": "A unique identifier for the dashboard.",
"in": "path",
"name": "id",
"required": true,
Expand Down Expand Up @@ -8862,10 +8872,11 @@
}
}
},
"summary": "Update an existing dashboard.",
"summary": "Update an existing dashboard",
"tags": [
"Dashboards"
]
],
"x-state": "Technical Preview"
}
},
"/api/fleet/agent_download_sources": {
Expand Down
31 changes: 21 additions & 10 deletions oas_docs/output/kibana.serverless.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5213,13 +5213,15 @@ paths:
enum:
- '2023-10-31'
type: string
- in: query
- description: The page number to return.
in: query
name: page
required: false
schema:
default: 1
type: number
- in: query
- description: The number of dashboards to display on each page.
in: query
name: perPage
required: false
schema:
Expand Down Expand Up @@ -5321,9 +5323,10 @@ paths:
required:
- items
- total
summary: Get a list of dashboards.
summary: Get a list of dashboards
tags:
- Dashboards
x-state: Technical Preview
x-beta: true
/api/dashboards/dashboard/{id}:
delete:
Expand All @@ -5345,15 +5348,17 @@ paths:
schema:
example: 'true'
type: string
- in: path
- description: A unique identifier for the dashboard.
in: path
name: id
required: true
schema:
type: string
responses: {}
summary: Delete a dashboard.
summary: Delete a dashboard
tags:
- Dashboards
x-state: Technical Preview
x-beta: true
get:
description: This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Expand All @@ -5367,7 +5372,8 @@ paths:
enum:
- '2023-10-31'
type: string
- in: path
- description: A unique identifier for the dashboard.
in: path
name: id
required: true
schema:
Expand Down Expand Up @@ -5821,9 +5827,10 @@ paths:
required:
- item
- meta
summary: Get a dashboard.
summary: Get a dashboard
tags:
- Dashboards
x-state: Technical Preview
x-beta: true
post:
description: This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Expand All @@ -5844,7 +5851,8 @@ paths:
schema:
example: 'true'
type: string
- in: path
- description: A unique identifier for the dashboard.
in: path
name: id
required: false
schema:
Expand Down Expand Up @@ -6664,6 +6672,7 @@ paths:
summary: Create a dashboard
tags:
- Dashboards
x-state: Technical Preview
x-beta: true
put:
description: This functionality is in technical preview and may be changed or removed in a future release. Elastic will work to fix any issues, but features in technical preview are not subject to the support SLA of official GA features.
Expand All @@ -6684,7 +6693,8 @@ paths:
schema:
example: 'true'
type: string
- in: path
- description: A unique identifier for the dashboard.
in: path
name: id
required: true
schema:
Expand Down Expand Up @@ -7497,9 +7507,10 @@ paths:
- references
required:
- item
summary: Update an existing dashboard.
summary: Update an existing dashboard
tags:
- Dashboards
x-state: Technical Preview
x-beta: true
/api/data_views:
get:
Expand Down
Loading

0 comments on commit b3a6fd7

Please sign in to comment.