cursor:
  name: cursor
  schema:
    type: string
    example: 0
  description: The cursor pointer to fetch paginated results (from `prevCursor` and `nextCursor`).

limit:
  name: limit
  schema:
    type: integer
    minimum: 1
    maximum: 1000
    enum:
      - 1
      - 5
      - 10
      - 25
      - 50
      - 100
      - 250
      - 500
      - 1000
    example: 1
  description: The maximum amount of entries to get.

sort:
  name: sort
  required: true
  schema:
    type: string
  description: The sort and order of the paginated entries.

fields:
  name: fields
  required: true
  schema:
    type: array
    items:
      type: string
    example:
      - mac
      - pid
      - ip4log.ip
  description: Comma delimited fields that should be added to the resource by performing joins. For example, in order to get the IP address of a node when calling the nodes endpoints, setting 'ip4log.ip' into this field will provide the latest IP address of the device in the 'ip4log.ip' field of every node that is returned.

search_query:
  in: path
  name: query
  required: true
  schema:
    $ref: "#/components/schemas/Search"
  description: The JSON encoded search query following the Search schema defined in this spec.

local:
  name: local
  required: true
  schema:
    type: integer
    default: 0
  description: The local is used to determine if the request should be forwarded to the rest of the cluster. A value of '0' forwards the request and either a missing or alternate value does not forward the request to the rest of the cluster.

ipset_name:
  in: path
  name: ipset_name
  required: true
  description: The name of the ipset to manipulate
  schema:
    type: string

service:
  in: path
  name: service
  required: true
  description: The name of the service to manage
  schema:
    type: string
