Available operators for filtering records using JSON:API

[lcmen]

Hello!
It's me again with more questions from Ash Framework book :).

I've just started a chapter on building JSON:API specification and I have a question about filter query param. This property can be used to filter the results. OpenAPI specification shows me a following list of available operators:

"artist-filter-name": {
  "additionalProperties": false,
  "properties": {
    "eq": {
      "type": "string"
    },
    "greater_than": {
      "type": "string"
    },
    "greater_than_or_equal": {
      "type": "string"
    },
    "ilike": {
      "type": "string"
    },
    "in": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "is_nil": {
      "type": "boolean"
    },
    "less_than": {
      "type": "string"
    },
    "less_than_or_equal": {
      "type": "string"
    },
    "like": {
      "type": "string"
    },
    "not_eq": {
      "type": "string"
    }
  },
  "type": "object"
}

While testing, I found that I'm also able to filter artists based on the name using contains operator (e.g. name[contains]=Syndicate). That query gets correctly translated to LIKE %Syndicate% SQL clause.

How is it possible to use an operator that is not listed above? What other operators are available and where I can find them?

Thanks!

[zachdaniel]

This is a bug in our filter spec generator 😄 The generated schema should contain all possible options. I will transfer this issue into ash_json_api and will investigate, thanks for the report!

[zachdaniel]

Oh, actually, this is just a discussion not an issue. @lcmen could you please open a bug report against ash_json_api?

[lcmen]

Sure. Here it is: ash-project/ash_json_api#302. I didn't know it's a bug :)

[zachdaniel]

Oh for sure :) totally cool to open a discussion are start a conversation before logging a bug report, I appreciate it