Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
kuzdogan opened this issue Jul 28, 2023 · 0 comments
Open

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

kuzdogan opened this issue Jul 28, 2023 · 0 comments
Labels
Bug Something that should be fixed.

Comments

@kuzdogan
Copy link

kuzdogan commented Jul 28, 2023

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.

@kuzdogan kuzdogan added the Bug Something that should be fixed. label Jul 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Something that should be fixed.
Projects
None yet
Development

No branches or pull requests

1 participant