mirror of
https://github.com/elastic/kibana.git
synced 2025-06-28 11:05:39 -04:00
6ac10e2e01
# Backport This will backport the following commits from `main` to `8.19`: - [Adds guidelines for designing HTTP APIs (#224348)](https://github.com/elastic/kibana/pull/224348) <!--- Backport version: 9.6.6 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sorenlouv/backport) <!--BACKPORT [{"author":{"name":"Christiane (Tina) Heiligers","email":"christiane.heiligers@elastic.co"},"sourceCommit":{"committedDate":"2025-06-24T15:01:06Z","message":"Adds guidelines for designing HTTP APIs (#224348)\n\nThis PR adds guidelines for designing Kibana HTTP APIs that are\nterraform-provider developer friendly.\nfix https://github.com/elastic/kibana/issues/224643\n\n## Summary\nKibana doesn't have specific guidelines for designing HTTP APIs. With\nincreasing constraints, it's time to document what was previously tribal\nknowledge.\n\nElasticsearch is far further along this road, and other teams have\ncompiled their own.\nThis document serves as guidelines to designing _public_ HTTP APIs that\nare suitable for managing with Terraform.\n\n## How to test this (recommended for easier reading)\n- pull this PR\n- setup\n[`docs.elastic.dev`](https://docs.elastic.dev/docs/local-dev-docs-setup)\nlocally\n- run `yarn dev` from `docs.elastic.dev`\n- review the docs live!\n\n\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"94b1174254614580507827a7b2f4cf02ef5ee533","branchLabelMapping":{"^v9.1.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Core","release_note:skip","v9.0.0","DevDocs","backport:version","v8.18.0","v9.1.0","v8.19.0"],"title":"Adds guidelines for designing HTTP APIs","number":224348,"url":"https://github.com/elastic/kibana/pull/224348","mergeCommit":{"message":"Adds guidelines for designing HTTP APIs (#224348)\n\nThis PR adds guidelines for designing Kibana HTTP APIs that are\nterraform-provider developer friendly.\nfix https://github.com/elastic/kibana/issues/224643\n\n## Summary\nKibana doesn't have specific guidelines for designing HTTP APIs. With\nincreasing constraints, it's time to document what was previously tribal\nknowledge.\n\nElasticsearch is far further along this road, and other teams have\ncompiled their own.\nThis document serves as guidelines to designing _public_ HTTP APIs that\nare suitable for managing with Terraform.\n\n## How to test this (recommended for easier reading)\n- pull this PR\n- setup\n[`docs.elastic.dev`](https://docs.elastic.dev/docs/local-dev-docs-setup)\nlocally\n- run `yarn dev` from `docs.elastic.dev`\n- review the docs live!\n\n\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"94b1174254614580507827a7b2f4cf02ef5ee533"}},"sourceBranch":"main","suggestedTargetBranches":["9.0","8.18","8.19"],"targetPullRequestStates":[{"branch":"9.0","label":"v9.0.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"8.18","label":"v8.18.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v9.1.0","branchLabelMappingKey":"^v9.1.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/224348","number":224348,"mergeCommit":{"message":"Adds guidelines for designing HTTP APIs (#224348)\n\nThis PR adds guidelines for designing Kibana HTTP APIs that are\nterraform-provider developer friendly.\nfix https://github.com/elastic/kibana/issues/224643\n\n## Summary\nKibana doesn't have specific guidelines for designing HTTP APIs. With\nincreasing constraints, it's time to document what was previously tribal\nknowledge.\n\nElasticsearch is far further along this road, and other teams have\ncompiled their own.\nThis document serves as guidelines to designing _public_ HTTP APIs that\nare suitable for managing with Terraform.\n\n## How to test this (recommended for easier reading)\n- pull this PR\n- setup\n[`docs.elastic.dev`](https://docs.elastic.dev/docs/local-dev-docs-setup)\nlocally\n- run `yarn dev` from `docs.elastic.dev`\n- review the docs live!\n\n\n\n\n### Checklist\n\nCheck the PR satisfies following conditions. \n\nReviewers should verify this PR satisfies this list as well.\n\n- [x]\n[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)\nwas added for features that require explanation or tutorials\n\n---------\n\nCo-authored-by: florent-leborgne <florent.leborgne@elastic.co>\nCo-authored-by: Elastic Machine <elasticmachine@users.noreply.github.com>","sha":"94b1174254614580507827a7b2f4cf02ef5ee533"}},{"branch":"8.19","label":"v8.19.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"}]}] BACKPORT--> Co-authored-by: Christiane (Tina) Heiligers <christiane.heiligers@elastic.co> 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 | ||