Skip to content

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

Description

@rassakhatsky

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
  }
}'

Activity

  1. jekh commented on Dec 10, 2023

    @jekh

    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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions