Skip to content

Commit

Permalink
[Fleet] OpenAPI add specs for all missing routes from #79574 (#106594)
Browse files Browse the repository at this point in the history 
## Summary
Add OpenAPI specs for all the missing routes mentioned in #79574

- [x] `/settings` [commit](da25a60)  & [PR docs](http://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/jfsiii/kibana/79574-missing-from-openapi/x-pack/plugins/fleet/common/openapi/bundled.json#operation/get-settings)
- [x] `/outputs` ef14345 & 0c1be7e [PR docs start here](http://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/jfsiii/kibana/79574-missing-from-openapi/x-pack/plugins/fleet/common/openapi/bundled.json#operation/get-output)
- [x] `/epm/packages/{pkgName}/stats` [commit](7d98448) & [PR docs](http://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/jfsiii/kibana/79574-missing-from-openapi/x-pack/plugins/fleet/common/openapi/bundled.json#operation/get-package-stats)



### Checklist
- [x] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials
  • Loading branch information
John Schulz authored Jul 22, 2021
1 parent dbfca5c commit 02e8e7f
Show file tree
Hide file tree
Showing 11 changed files with 674 additions and 0 deletions.
297 changes: 297 additions & 0 deletions x-pack/plugins/fleet/common/openapi/bundled.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,42 @@
]
}
},
"/settings": {
"get": {
"summary": "Settings",
"tags": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fleet_settings_response"
}
}
}
}
},
"operationId": "get-settings"
},
"post": {
"summary": "Settings - Update",
"tags": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/fleet_settings_response"
}
}
}
}
},
"operationId": "update-settings"
}
},
"/epm/categories": {
"get": {
"summary": "Package categories",
Expand Down Expand Up @@ -1643,6 +1679,173 @@
}
]
}
},
"/outputs": {
"get": {
"summary": "Outputs",
"tags": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/output"
}
},
"total": {
"type": "integer"
},
"page": {
"type": "integer"
},
"perPage": {
"type": "integer"
}
}
}
}
}
}
},
"operationId": "get-outputs"
}
},
"/outputs/{outputId}": {
"get": {
"summary": "Output - Info",
"tags": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/output"
}
},
"required": [
"item"
]
}
}
}
}
},
"operationId": "get-output"
},
"parameters": [
{
"schema": {
"type": "string"
},
"name": "outputId",
"in": "path",
"required": true
}
],
"put": {
"summary": "Output - Update",
"operationId": "update-output",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"hosts": {
"type": "string"
},
"ca_sha256": {
"type": "string"
},
"config": {
"type": "object"
},
"config_yaml": {
"type": "string"
}
}
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/output"
}
},
"required": [
"item"
]
}
}
}
}
},
"parameters": [
{
"$ref": "#/components/parameters/kbn_xsrf"
}
]
}
},
"/epm/packages/{pkgName}/stats": {
"get": {
"summary": "Get stats for a package",
"tags": [],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"response": {
"$ref": "#/components/schemas/package_usage_stats"
}
},
"required": [
"response"
]
}
}
}
}
},
"operationId": "get-package-stats",
"security": [
{
"basicAuth": []
}
]
},
"parameters": [
{
"schema": {
"type": "string"
},
"name": "pkgName",
"in": "path",
"required": true
}
]
}
},
"components": {
Expand Down Expand Up @@ -1733,6 +1936,43 @@
"nonFatalErrors"
]
},
"settings": {
"title": "Settings",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"has_seen_add_data_notice": {
"type": "boolean"
},
"has_seen_fleet_migration_notice": {
"type": "boolean"
},
"fleet_server_hosts": {
"type": "array",
"items": {
"type": "string"
}
}
},
"required": [
"fleet_server_hosts",
"id"
]
},
"fleet_settings_response": {
"title": "Fleet settings response",
"type": "object",
"properties": {
"item": {
"$ref": "#/components/schemas/settings"
}
},
"required": [
"item"
]
},
"search_result": {
"title": "Search result",
"type": "object",
Expand Down Expand Up @@ -2389,6 +2629,63 @@
"$ref": "#/components/schemas/new_package_policy"
}
]
},
"output": {
"title": "Output",
"type": "object",
"properties": {
"id": {
"type": "string"
},
"is_default": {
"type": "boolean"
},
"name": {
"type": "string"
},
"type": {
"type": "string",
"enum": [
"elasticsearch"
]
},
"hosts": {
"type": "array",
"items": {
"type": "string"
}
},
"ca_sha256": {
"type": "string"
},
"api_key": {
"type": "string"
},
"config": {
"type": "object"
},
"config_yaml": {
"type": "string"
}
},
"required": [
"id",
"is_default",
"name",
"type"
]
},
"package_usage_stats": {
"title": "Package usage stats",
"type": "object",
"properties": {
"agent_policy_count": {
"type": "integer"
}
},
"required": [
"agent_policy_count"
]
}
}
},
Expand Down
Loading

0 comments on commit 02e8e7f

Please sign in to comment.