Skip to content

Parameters missing in OpenAPI spec at /pinning/pins #994

Open

Description

@kuzdogan

While trying to get our all pins, I noticed the parameters for the endpoint /pinning/pins is missing in the OpenAPI spec (and SwaggerUI).

I figured out by looking at the code

qcids := c.QueryParam("cid")
qname := c.QueryParam("name")
qmatch := c.QueryParam("match")
qstatus := c.QueryParam("status")
qbefore := c.QueryParam("before")
qafter := c.QueryParam("after")
qlimit := c.QueryParam("limit")
qreqids := c.QueryParam("requestid")

but also it wasn't clear at first if there's pagination or not. I guess the way to paginate in a way is to use before and after right? When using before I also had trouble getting the date syntax right. This worked for me ?before=2023-06-28T15:00:00Z but it would be nice to have this in the docs as well.

Edit: An additional thing to make clear can be the pinid field. In the response it is requestId and not pinId. I assumed it is the pin.cid in the response which is the CID of the pin. In the Estuary dashboard it name "Pin ID" whereas in the API response it's requestId.

Activity

  1. added
    BugSomething that should be fixed.
    on Jul 28, 2023
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

    BugSomething that should be fixed.

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions