/credential-authorizations endpoint missing per_page and page query params

Open
#89 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Stale
Tech stack
github, openapi, python
Domain
api

Research direction

Start by locating the OpenAPI definition for the Credential Authorizations endpoint and compare it with the linked GitHub REST documentation. Add the per_page and page query parameters, then verify the API specification accepts both parameters.

Written by the indexing model from the issue text.

Description

It looks like the API spec for Credential Authorizations is missing the per_page and page params.

Calling the endpoint without these params will return 30 results.

In the Link header of the response it will include the next page, and the last page

<https://api.github.com/organizations/{orgid}/credential-authorizations?page=2>; rel="next",
<https://api.github.com/organizations/{orgid}/credential-authorizations?page=66>; rel="last"

Calling the API and passing in `?per_page=100&page=1'

Returns 100 results, and the following for Link header

<https://api.github.com/organizations/{orgid}/credential-authorizations?per_page=100&page=2>; rel="next",
<https://api.github.com/organizations/{orgid}/credential-authorizations?per_page=100&page=20>; rel="last"
Dominant language
Python
Stars
687
Forks
69
Avg merge
1m
Merged PRs (30d)
2

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from AnswerDotAI/ghapi

All issues in AnswerDotAI/ghapi

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.