Forums

Articles
Create
cancel
Showing results for 
Search instead for 
Did you mean: 

Feature: request to extend swagger definition with pagination parameters

Sander Mol
Contributor
January 29, 2023

Greetings Atlassian,

The current OpenAPI/swagger defintion of Bitbucket Cloud does not contain consistent definitions of the HTTP parameters if `page` and `pagelen` which are used to control the pagination of paginated collections.

Only GET /2.0/repositories/{workspace}/{repo_slug}/commit/{commit}/pullrequests contains this definition currently.

My request to add these parameters to all paginated objects, so clients can properly get generated with pagination support. This is about the following OpenAPI definitions:

parameters: [
...
{
"name": "pagelen",
"in": "query",
"description": "How many pull requests to retrieve per page",
"required": false,
"type": "integer",
"default": 10,
"format": "int32"
},
{

"name": "page",
"in": "query",
"description": "Which page to retrieve",
"required": false,
"type": "integer",
"default": 1,
"format": "int32"
}]

1 answer

1 accepted

1 vote
Answer accepted
Theodora Boudale
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 3, 2023

Hi Sander!

I went ahead and created a request in our issue tracker here:

You can add your vote and comment to that ticket to further express your interest.

Please feel free to let me know if you have any questions.

Kind regards,
Theodora

Sander Mol
Contributor
February 3, 2023

Amazing! If I could, I would contribute myself :) Hopefully this is the right way to communicate these requests. Appreciate the effort!

Theodora Boudale
Atlassian Team
Atlassian Team members are employees working across the company in a wide variety of roles.
February 6, 2023

You are welcome, Sander! And yes, it's ok to communicate these requests here. If you’re on a Standard or Premium plan you can also create a ticket with the support team via this link: https://support.atlassian.com/contact/#/?inquiry_category=technical_issues&support_type=customer and the engineer working on your support ticket can also create a feature request / bug report.

You can check if there is an existing request for what you are asking by searching in our issue tracker:

https://jira.atlassian.com/browse/BCLOUD-22452?jql=project%20%3D%20BCLOUD

Suggest an answer

Log in or Sign up to answer
DEPLOYMENT TYPE
CLOUD
PERMISSIONS LEVEL
Product Admin
TAGS
AUG Leaders

Atlassian Community Events