Skip to content
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

[Schema Inaccuracy] sort parameter is available but not documented. #114

Open
rassakhatsky opened this issue Oct 10, 2023 · 1 comment
Open

Comments

@rassakhatsky
Copy link

Schema Inaccuracy

The searchConversations endpoint lacks documentation for the sort option, which is available but not mentioned. I'm trying to generate a Golang client.

Expected

I expect the documentation to include information about the sort functionality.

Reproduction Steps

Use the following cURL command with your Intercom API token:

curl -i -X POST \
  https://api.intercom.io/conversations/search \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -H 'Intercom-Version: 2.10' \
  -d '{
  "sort": {
    "field": "id",
    "order": "ascending"
  },
  "query": {
    // YOUR_QUERY_HERE
  }
}'
@jekh
Copy link

jekh commented Dec 10, 2023

I believe this applies to other Search* operations too, such as SearchContacts.

I found the documentation for sort here: https://developers.intercom.com/docs/build-an-integration/learn-more/rest-apis/pagination-sorting-search/#sorting

But since it's not in the schema, it obviously makes consuming it in clients generated from the OpenAPI spec rather difficult.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants