mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
94b1174254
This PR adds guidelines for designing Kibana HTTP APIs that are terraform-provider developer friendly. fix https://github.com/elastic/kibana/issues/224643 ## Summary Kibana doesn't have specific guidelines for designing HTTP APIs. With increasing constraints, it's time to document what was previously tribal knowledge. Elasticsearch is far further along this road, and other teams have compiled their own. This document serves as guidelines to designing _public_ HTTP APIs that are suitable for managing with Terraform. ## How to test this (recommended for easier reading) - pull this PR - setup [`docs.elastic.dev`](https://docs.elastic.dev/docs/local-dev-docs-setup) locally - run `yarn dev` from `docs.elastic.dev` - review the docs live!  ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [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: florent-leborgne <florent.leborgne@elastic.co> Co-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com> |
||
|---|---|---|
| .. | ||
| best_practices.mdx | ||
| code_walkthrough.mdx | ||
| dev_principles.mdx | ||
| documentation.mdx | ||
| how_we_use_github.mdx | ||
| kibana_http_api_guidelines.mdx | ||
| standards.mdx | ||
| third_party_dependencies.mdx | ||