[Connector API] Add docs for create connector API #103177
Merged
Conversation
This file contains 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
jedrazb
added
>docs
|
Documentation preview: |
|
Pinging @elastic/es-docs (Team:Docs) |
|
Pinging @elastic/ent-search-eng (Team:Enterprise Search) |
abdonpijpelink
approved these changes
Dec 8, 2023
| [[create-connector-api-response-codes]] | ||
| ==== {api-response-codes-title} | ||
|
|
||
| `200`:: |
There was a problem hiding this comment.
It may be good to list other response codes too? Just playing around with the API a bit, I came across a 201 and a 500.
There was a problem hiding this comment.
Yup added more. Actually the 500 is unexpected - I filed an issue to make a request body a required param (otherwise, without providing the body we can get 500 NullPointerException which is not clear to the user). Will fix it soon
Co-authored-by: Abdon Pijpelink <[email protected]>
Co-authored-by: Abdon Pijpelink <[email protected]>
Co-authored-by: Abdon Pijpelink <[email protected]>
Co-authored-by: Abdon Pijpelink <[email protected]>
Co-authored-by: Abdon Pijpelink <[email protected]>
Co-authored-by: Abdon Pijpelink <[email protected]>
…drazb/elasticsearch into connector-api-post-request-documented
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
jedrazb
added a commit
to jedrazb/elasticsearch
that referenced
this pull request
Dec 12, 2023
(cherry picked from commit 73644bd)
elasticsearchmachine
pushed a commit
that referenced
this pull request
Dec 12, 2023
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.
Adds documentation for the query connector management API. First API documented: create a connector.