Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-1310566642.9 KB
Development Information

Get repository

For the specified repository ID, retrieves the repository and the most recent 400 development information entities. The result will be what is currently stored, ignoring any pending updates or deletes.

get/rest/devinfo/0.10/repository/{repositoryId}

Path parameters

repositoryIdstring required

The ID of repository to fetch

Headers

Authorizationstring required

All requests must be signed with either a Connect JWT token or OAuth token for an on-premise integration that corresponds to an app installed in Jira. If the JWT token corresponds to a Connect app that does not define the jiraDevelopmentTool module it will be rejected with a 403. See https://developer.atlassian.com/blog/2015/01/understanding-jwt/ for more details about Connect JWT tokens. See https://developer.atlassian.com/cloud/jira/software/integrate-jsw-cloud-with-onpremises-tools/ for details about on-premise integrations.

Response

The repository data currently stored for the given ID.

namestring required

The name of this repository. Max length is 255 characters.

descriptionstring

Description of this repository. Max length is 1024 characters.

forkOfstring

The ID of the repository this repository was forked from, if it's a fork. Max length is 1024 characters.

urlstring url required

The URL of this repository. Max length is 2000 characters.

avatarstring url

The URL of the avatar for this repository. Max length is 2000 characters.

avatarDescriptionstring

Description of the avatar for this repository. Max length is 1024 characters.

idstring required

The ID of this entity. Will be used for cross entity linking. Must be unique by entity type within a repository, i.e., only one commit can have ID 'X' in repository 'Y'. But adding, e.g., a branch with ID 'X' to repository 'Y' is acceptable. Only alphanumeric characters, and '~.-_', are allowed. Max length is 1024 characters.

updateSequenceIdinteger required

An ID used to apply an ordering to updates for this entity in the case of out-of-order receipt of update requests. This can be any monotonically increasing number. A suggested implementation is to use epoch millis from the provider system, but other alternatives are valid (e.g. a provider could store a counter against each entity and increment that on each update to Jira). Updates for an entity that are received with an updateSqeuenceId lower than what is currently stored will be ignored.

Example response

{
  "name": "atlassian-connect-jira-example",
  "description": "The repository which stores code of the Atlassian Connect Add-on Devinfo application.",
  "forkOf": "56c7c750-cee2-48e2-b920-d7706dfd11f7",
  "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example",
  "commits": [
    {
      "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ABC-123",
            "ABC-456"
          ]
        }
      ],
      "updateSequenceId": 1523494301248,
      "message": "README.md edited online with Bitbucket",
      "author": {
        "name": "Jane Doe",
        "email": "jane_doe@atlassian.com",
        "username": "jdoe",
        "url": "https://atlassian.com/account/jane_doe",
        "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
      },
      "fileCount": 1,
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
      "files": [
        {
          "path": "/home/user/src/atlassian-connect-jira-example/README.md",
          "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
          "changeType": "MODIFIED",
          "linesRemoved": 1
        }
      ],
      "authorTimestamp": "2016-10-31T23:27:25+00:00",
      "displayId": "a7727ee"
    }
  ],
  "branches": [
    {
      "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ABC-123",
            "ABC-456"
          ]
        }
      ],
      "updateSequenceId": 1523494301248,
      "name": "master",
      "lastCommit": {
        "id": "a7727ee6350c33cdf90826dc21abaa26a5704370",
        "updateSequenceId": 1523494301248,
        "message": "README.md edited online with Bitbucket",
        "author": {
          "name": "Jane Doe",
          "email": "jane_doe@atlassian.com",
          "username": "jdoe",
          "url": "https://atlassian.com/account/jane_doe",
          "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
        },
        "fileCount": 1,
        "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/commits/a7727ee6350c33cdf90826dc21abaa26a5704370",
        "files": [
          {
            "path": "/home/user/src/atlassian-connect-jira-example/README.md",
            "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/a7727ee6350c33cdf90826dc21abaa26a5704370/README.md",
            "changeType": "MODIFIED",
            "linesRemoved": 1
          }
        ],
        "authorTimestamp": "2016-10-31T23:27:25+00:00",
        "displayId": "a7727ee"
      },
      "createPullRequestUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/new",
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/master"
    }
  ],
  "pullRequests": [
    {
      "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
      "associations": [
        {
          "associationType": "issueIdOrKeys",
          "values": [
            "ABC-123",
            "ABC-456"
          ]
        }
      ],
      "updateSequenceId": 1523494301248,
      "status": "OPEN",
      "title": "Pull request 2, fixing all the issues caused by pull request #1",
      "author": {
        "name": "Jane Doe",
        "email": "jane_doe@atlassian.com",
        "username": "jdoe",
        "url": "https://atlassian.com/account/jane_doe",
        "avatar": "https://atlassian.com/account/jane_doe/avatar/32"
      },
      "commentCount": 42,
      "sourceBranch": "ISSUE-1-feature-branch",
      "sourceBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/branch/ISSUE-1-feature-branch",
      "lastUpdate": "2016-10-31T23:27:25+00:00",
      "destinationBranch": "master",
      "destinationBranchUrl": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/src/master",
      "reviewers": [
        {
          "name": "Jane Doe",
          "approvalStatus": "APPROVED",
          "url": "https://atlassian.com/account/jane_doe",
          "avatar": "https://atlassian.com/account/jane_doe/avatar/32",
          "email": "jane_doe@example.com",
          "accountId": "655363:e4ca5e2d-a901-40e3-877e-bf5d22c0f130"
        }
      ],
      "url": "https://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/pull-requests/2",
      "displayId": "Pull request 2"
    }
  ],
  "avatar": "http://bitbucket.org/atlassianlabs/atlassian-connect-jira-example/avatar/32",
  "avatarDescription": "Avatar description",
  "id": "c6c7c750-cee2-48e2-b920-d7706dfd11f9",
  "updateSequenceId": 1523494301248
}