Skip to content

OpenAPI specification document for Intelligent X Search API #534

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: master
Choose a base branch
from

Conversation

Azuris2
Copy link

@Azuris2 Azuris2 commented Mar 18, 2024

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):

  • Intelligent/search endpoint - returns altterm and altermh that wasn't specified in the docs. I'm not sure if this was due to a recent change, or due to an upgrade of my API key. For the dates, I'm not too sure what the format should be so I've listed them as a string. (It wouldn't throw up an error for incorrect dates)
  • Intelligent/search/result endpoint - returns a few key-value pairs that were not defined in the API docs. Also, in my testing, the "type" gave me a value of 1006 that was not defined in the API docs.
  • Phonebook/search/result endpoint - I originally referenced the intelligent/search/result response for this, but I realised that the actual response is quite different from the initial documentation and they were not defined. E.g. selectors, selectortype. Would need to be re-documented if that's indeed the case.
  • For the file/preview endpoints, I wasn't able to test it as I'm not sure how some of the parameters were defined (along with their available values).
  • I've left some key-value pairs/parameters blank as I wasn't too clear on what their definition/values were.
  • Lastly, I noticed that some parameters have the same definition/values but they are named differently. Just something to keep in mind as they have to be defined separately in the spec. E.g. systemid vs sid

I would be happy to keep working on the documentation if you have any feedback.

Cheers!

@cmlh cmlh self-assigned this Mar 21, 2024
@cmlh cmlh added enhancement New feature or request docs labels Mar 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants