UNPKG

kibana-123

Version:

Kibana is an open source (Apache Licensed), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elastic

33 lines (22 loc) 683 B
# API Style Guide ## Paths API routes must start with the `/api/` path segment, and should be followed by the plugin id if applicable: *Right:* `/api/marvel/nodes` *Wrong:* `/marvel/api/nodes` ## Versions Kibana won't be supporting multiple API versions, so API's should not define a version. *Right:* `/api/kibana/index_patterns` *Wrong:* `/api/kibana/v1/index_patterns` ## snake_case Kibana uses `snake_case` for the entire API, just like Elasticsearch. All urls, paths, query string parameters, values, and bodies should be `snake_case` formatted. *Right:* ``` POST /api/kibana/index_patterns { "id": "...", "time_field_name": "...", "fields": [ ... ] } ```