kibana/dev_docs
Christiane (Tina) Heiligers 94b1174254
Adds guidelines for designing HTTP APIs (#224348)
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!

![Screenshot 2025-06-19 at 14 58
48](https://github.com/user-attachments/assets/bda09e04-8351-4f78-b8df-ebfd7b248903)


### 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>
2025-06-24 08:01:06 -07:00
..
assets Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
contributing Adds guidelines for designing HTTP APIs (#224348) 2025-06-24 08:01:06 -07:00
getting_started Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
key_concepts Update anatomy_of_a_plugin.mdx (#222857) 2025-06-23 10:46:00 +02:00
lens [Lens] fit line charts by default (#196184) 2024-10-21 15:05:02 +02:00
operations [Core Rendering Service] Mark KibanaRenderContextProvider as deprecated (#219313) 2025-04-29 17:14:28 -07:00
shared_ux Optimize existing image assets with lossless compression (#223998) 2025-06-19 16:44:13 +02:00
tutorials APEX-72 Enforce Kibana >= 8.18.0; Remove switchToModelVersionAt (#220985) 2025-06-20 16:41:54 +02:00
api_welcome.mdx SKA: Update broken references and URLs (#206836) 2025-01-28 03:32:48 +00:00
kibana_server_core_components.mdx Clean up dev docs (#124271) 2022-02-03 10:09:10 -05:00
nav-kibana-dev.docnav.json Adds guidelines for designing HTTP APIs (#224348) 2025-06-24 08:01:06 -07:00