Create
cancel
Showing results for 
Search instead for 
Did you mean: 
Sign up Log in
Celebration

Earn badges and make progress

You're on your way to the next level! Join the Kudos program to earn points and save your progress.

Deleted user Avatar
Deleted user

Level 1: Seed

25 / 150 points

Next: Root

Avatar

1 badge earned

Collect

Participate in fun challenges

Challenges come and go, but your rewards stay with you. Do more to earn more!

Challenges
Coins

Gift kudos to your peers

What goes around comes around! Share the love by gifting kudos to your peers.

Recognition
Ribbon

Rise up in the ranks

Keep earning points to reach the top of the leaderboard. It resets every quarter so you always have a chance!

Leaderboard

Come for the products,
stay for the community

The Atlassian Community can help you and your team get more value out of Atlassian products and practices.

Atlassian Community about banner
4,506,628
Community Members
 
Community Events
180
Community Groups

How can I see all parameters for a REST API resource?

Hello,

I'm scripting some bitbucket DC calls to automate some of our work, like for instance the creation and configuration of a repository.

I've found this documentation here https://docs.atlassian.com/bitbucket-server/rest/7.21.0/bitbucket-rest.html#idp175

But I'm having a hard time to find the parameters/options/objects I can use in a request body, for instance, to create a repo I can use the following json body:

{
    "name": "My repo",
    "scmId": "git",
    "forkable": true,
    "defaultBranch": "main"
}

But, there are more parameters than that, right? Like the description.

{
    "name": "My repo",
    "scmId": "git",
    "forkable": true,
    "defaultBranch": "main",
"description": "aaa bbb my desc" }

There's any documentation or some place where I can see all the parameters I can send in a json body?

Thx!

1 answer

0 votes

Hello @Jonathan Ghellere 

What happens when you try to create a new repository while providing the description parameter in the body of the request?

Then it seems like you've found an omission in the documentation.

Send that feedback to Atlassian to have the description parameter included in the example for that REST API endpoint.

Hye David, thx for you contribution.

Actually we have more parameters that are not there in the documentation. My question is not related to the omission but where I can get a list of all parameters.

Creating the repo is only the beginning, I would like to automate the branch config, groups and other stuff.. 
A complete API documentation would be awesome. There's any anywhere?

Suggest an answer

Log in or Sign up to answer
TAGS
AUG Leaders

Atlassian Community Events