Parameter missing in swagger API spec. (see https://listmonk.app/docs/swagger/collections.yaml )

[stargazer33]

Version:
latest, see https://listmonk.app/docs/swagger/collections.yaml

The collections.yaml contains formal description of
GET /subscribers

  /subscribers:
    get:
      tags:
        - Subscribers
      description: returns all subscribers.
      parameters:
        - in: query
          name: page
          description: number of records to skip
          schema:
            type: integer
            format: int32
        - in: query
          name: per_page
          description: max number of records to return per page
          schema:
            type: integer
            format: int32

The collections.yaml missing the query parameter!

Compare it with the documentation page providing example of GET /subscribers:

GET /api/subscribers
Gets subscribers with an SQL expression.

Example Request
curl -X GET 'http://localhost:9000/api/subscribers' \
    --url-query 'page=1' \
    --url-query 'per_page=100' \
    --url-query "query=subscribers.name LIKE 'Test%' AND subscribers.attribs->>'city' = 'Bengaluru'"

To skip pagination and retrieve all records, pass per_page=all.

[knadh]

Thanks @stargazer33. Please feel free to send a PR with any fixes. I'm not familiar with the OpenAPI spec.

[stargazer33]

Thanks @stargazer33. Please feel free to send a PR with any fixes. I'm not familiar with the OpenAPI spec.

Well, it is not related to OpenAPI at all, it is about correctness/consistence of documentation for humans and machine-readable documentation in collections.yaml

[knadh]

Indeed. I meant, I'm not familiar with the spec to quickly edit the collection myself.