The Repository object type represents Developer Information (DevInfo) repository entity. It is used as a container for other DevInfo nouns. atlassian:repository should be used to ingest repository-specific fields.

Payload structure

1
2
  objects {}
  ├─ schemaVersion (string) [Required]
  ├─ id (string) [Required]
  ├─ updateSequenceNumber (long) [Required]
  ├─ displayName (string) [Required]
  ├─ description (string) [Optional]
  ├─ url (string) [Required]
  ├─ createdAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ createdBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ lastUpdatedAt (Instant (ISO8601 / RFC3339)) [Required]
  └─ lastUpdatedBy (userReference) [Optional]
      ├─ accountId (string) [Optional]
      ├─ email (string) [Optional]
      └─ externalId (string) [Required]
  └─ permissions [] [Required] 
      └─ accessControls
         └─ principals
            └─type
  └─ associations [] [Optional]
      ├─ associationType (string)
      └─ values []

  atlassian:repository
  ├─ name (string) [Optional]
  ├─ forkOf (string) [Optional]
  ├─ avatar (string) [Optional]
  └─ avatarDescription (string) [Optional]

Common properties

Property	Type	Required	Description
`schemaVersion`	`string`	Yes	The schema version of the object.
`id`	`string`	Yes	The ID of the object in the source system.
`updateSequenceNumber`	`long`	Yes	A sequence number to compare when writing to the database. Objects are written following a last write wins strategy, therefore an object with a greater `UpdateSequenceNumber` is considered a more recently updated object.
`displayName`	`string`	Yes	The display name of the object.
`description`	`string`	No	The description of the object.
`url`	`string`	Yes	The URL from the provider which the object is accessible from.
`createdAt`	`string`	Yes	The date the object was created. Format: Instant (ISO8601 / RFC3339)
`createdBy`	`userReference`	No	A reference to the user that created the object. See userReference to learn more.
`lastUpdatedAt`	`string`	Yes	The date the object was last updated. Format: Instant (ISO8601 / RFC3339)
`lastUpdatedBy`	`userReference`	No	A reference to the user that last updated the object. See userReference to learn more.
`owners`	`list<userReference>`	No	List of references of users that own the object.
`thumbnail`	`thumbnail`	No	The thumbnail of the object. See Thumbnail to learn more.
`parentKey`	`entityKey`	No	The ID of the parent object. If null, it is a standalone object. See Entity key to learn more.
`containerKey`	`entityKey`	No	The container identifier that this object belongs to. See Entity key to learn more.
`permissions`	`list<Permissions>`	Yes	The permissions configuration of the object. See Permissions to learn more.
`associations`	`association`	No	List of objects associated with the object. Generally used to link an external object to a Atlassian object. See Association to learn more.

Repository properties

Property	Type	Required	Description
`name`	`string`	No	The name of the repository. Validation: max-length: 255
`forkOf`	`string`	No	The repository that this repository is a fork of. Validation: max-length: 255
`avatar`	`string`	No	The repository avatar URL. Format: Valid URL
`avatarDescription`	`string`	No	The repository avatar description. Validation: max-length: 1024

Example payload

1
2
{
  "objects" : [ {
    "schemaVersion" : "2.0",
    "id" : "repo-1",
    "updateSequenceNumber" : 1,
    "displayName" : "My cool repository",
    "description" : "A really cool repository that does stuff",
    "url" : "https://bitbucket.org/atlassian/jswdd-processor/src/master/",
    "createdAt" : "2023-07-18T10:00:00.000Z",
    "lastUpdatedAt" : "2023-07-19T15:27:37.000Z",
    "permissions" : [ {
      "accessControls" : [ {
        "principals" : [ {
          "type" : "ATLASSIAN_WORKSPACE"
        } ]
      } ]
    } ],
    "atlassian:repository" : {
      "name" : "jswdd-processor",
      "forkOf" : "repo-2",
      "avatar" : "https://bitbucket.org/atlassian/avatar.png",
      "avatarDescription" : "Repository avatar"
    }
  } ]
}