[Ingest Manager] Missing parts in OpenAPI specs #79574
Labels
Comments
neptunian
added
Meta
Team:Fleet
|
Pinging @elastic/ingest-management (Team:Ingest Management) |
jfsiii
changed the title
|
Added |
4 tasks
jfsiii
pushed a commit
that referenced
this issue
Jul 22, 2021
## 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
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Jul 22, 2021
…lastic#106594) ## Summary Add OpenAPI specs for all the missing routes mentioned in elastic#79574 - [x] `/settings` [commit](elastic@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` elastic@ef14345 & elastic@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](elastic@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
kibanamachine
pushed a commit
to kibanamachine/kibana
that referenced
this issue
Jul 22, 2021
…lastic#106594) ## Summary Add OpenAPI specs for all the missing routes mentioned in elastic#79574 - [x] `/settings` [commit](elastic@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` elastic@ef14345 & elastic@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](elastic@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
I didn't get to verify this goal/implementation but if both are correct, the change is very small. Changing kibana/x-pack/plugins/fleet/common/openapi/entrypoint.yaml Lines 88 to 89 in 02e8e7f to security:
- basicAuth: []
- Access_API_Key: []should do the trick. That says use either of these security schemes for all endpoints. |
kibanamachine
added a commit
that referenced
this issue
Jul 22, 2021
#106610) ## 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 Co-authored-by: John Schulz <[email protected]>
kibanamachine
added a commit
that referenced
this issue
Jul 23, 2021
#106611) ## 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 Co-authored-by: John Schulz <[email protected]>
|
Api key for auth is a Kibana-wide API option, so closing as rest of items are fixed. |
@jen-huang Regardless of where it originates, it should still be documented, IMO. The change is pretty straightforward #79574 (comment)
What about the endpoints at the top of the description? Those are routes I saw in https://github.com/elastic/kibana/blob/master/x-pack/plugins/fleet/common/constants/routes.ts but not the spec. If they're no longer active, they should be removed from
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Some items are missing from
common/openapi/endpoint.yamlapikeyId:apiKeyfor header valueMissing endpoints
/data_streams/agent_policies/{agentPolicyId}/full/agent_policies/{agentPolicyId}/download/check-permissions/service-tokens/setup/preconfiguration/agents/{agentId}/checkin/agents/{agentId}/actions/settings[Fleet] OpenAPI add specs for all missing routes from #79574 #106594/outputs[Fleet] OpenAPI add specs for all missing routes from #79574 #106594/agents/bulk_unenrollPR/agents/{agentId}/reassignPR/agents/bulk_reassignPR/epm/packages/{pkgName}/stats[Fleet] OpenAPI add specs for all missing routes from #79574 #106594Missing responses
paths/agent_status.yamlpaths/agents@{agent_id}@events.yamlpaths/agents@{agent_id}@unenroll.yamlpaths/enrollment_api_keys.yamlpaths/enrollment_api_keys@{key_id}.yamlpaths/agents@{agent_id}.yamlpaths/install@{os_type}.yamlThe text was updated successfully, but these errors were encountered: