OpenAPI specification document for Intelligent X Search API #534
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.
I've just uploaded the OpenAPI docs for the search API. I cleaned up some of the text and made some edits based on my testing with the API. For some of the details such as the license limitations and the User-Agent header, I've left them out to avoid bloating the doc, but if its beneficial, I could include them instead.
Some issues I had (some are left as a comment on the file):
I would be happy to keep working on the documentation if you have any feedback.
Cheers!