[9.0] Adds guidelines for designing HTTP APIs (#224348) #225100
Merged
+505
−0
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This PR adds guidelines for designing Kibana HTTP APIs that are terraform-provider developer friendly. fix elastic#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> (cherry picked from commit 94b1174)
1 task
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Backport
This will backport the following commits from
mainto9.0:Questions ?
Please refer to the Backport tool documentation