API: Repositories

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of the resource within OpenProject",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "description": "Name of the branch",
      "readOnly": true
    },
    "projectName": {
      "type": "string",
      "description": "Name of the project on the provider, e.g. `my-group/my-project`",
      "readOnly": true
    },
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the branch on the provider's website",
      "readOnly": true
    },
    "author": {
      "description": "The user on the provider who created the resource. Null if unknown.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/RepositoryUserModel"
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was first synchronized into OpenProject",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last synchronized into OpenProject",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This branch\n\n**Resource**: RepositoryBranch",
              "readOnly": true
            }
          ]
        },
        "workPackage": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The work package this branch belongs to\n\n**Resource**: WorkPackage",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "examples": [
    {
      "_type": "RepositoryBranch",
      "_links": {
        "self": {
          "href": "/api/v3/repository_branches/1",
          "title": "bug/1234-crash-when-saving"
        },
        "workPackage": {
          "href": "/api/v3/work_packages/1234",
          "title": "Crash when saving"
        }
      },
      "id": 1,
      "name": "bug/1234-crash-when-saving",
      "projectName": "my-group/my-project",
      "webUrl": "https://gitlab.example.com/my-group/my-project/-/tree/bug/1234-crash-when-saving",
      "author": {
        "name": "Jane Doe",
        "username": "jdoe",
        "avatarUrl": "https://gitlab.example.com/uploads/user/avatar/1/avatar.png"
      },
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:00.000Z"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of the resource within OpenProject",
      "readOnly": true
    },
    "sha": {
      "type": "string",
      "description": "SHA of the commit",
      "readOnly": true
    },
    "message": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Formattable"
        },
        {
          "description": "Commit message",
          "readOnly": true
        }
      ]
    },
    "authorName": {
      "type": "string",
      "description": "Author name as recorded in the commit",
      "readOnly": true
    },
    "authoredAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the commit was authored",
      "readOnly": true
    },
    "projectName": {
      "type": "string",
      "description": "Name of the project on the provider, e.g. `my-group/my-project`",
      "readOnly": true
    },
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the resource on the provider's website",
      "readOnly": true
    },
    "author": {
      "description": "The user on the provider who created the resource. Null if unknown.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/RepositoryUserModel"
        },
        {
          "type": "null"
        }
      ]
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was first synchronized into OpenProject",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last synchronized into OpenProject",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This commit\n\n**Resource**: RepositoryCommit",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "examples": [
    {
      "_type": "RepositoryCommit",
      "_links": {
        "self": {
          "href": "/api/v3/repository_commits/1",
          "title": "Fix crash when saving"
        }
      },
      "id": 1,
      "sha": "0a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
      "message": {
        "format": "plain",
        "raw": "Fix crash when saving\n\nOP#1234",
        "html": "<p>Fix crash when saving</p><p>OP#1234</p>"
      },
      "authorName": "Jane Doe",
      "authoredAt": "2026-10-01T12:00:00.000Z",
      "projectName": "my-group/my-project",
      "webUrl": "https://gitlab.example.com/my-group/my-project/-/commit/0a1b2c3d4e5f60718293a4b5c6d7e8f901234567",
      "author": {
        "name": "Jane Doe",
        "username": "jdoe",
        "avatarUrl": "https://gitlab.example.com/uploads/user/avatar/1/avatar.png"
      },
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:00.000Z"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of the resource within OpenProject",
      "readOnly": true
    },
    "displayId": {
      "type": "string",
      "description": "Identifier of the issue as displayed by the provider, e.g. `42`",
      "readOnly": true
    },
    "title": {
      "type": "string",
      "description": "Title of the issue",
      "readOnly": true
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Formattable"
        },
        {
          "description": "Description of the issue",
          "readOnly": true
        }
      ]
    },
    "state": {
      "type": "string",
      "description": "State of the issue as reported by the provider, e.g. `opened`",
      "readOnly": true
    },
    "labels": {
      "type": "array",
      "description": "Labels attached to the resource on the provider",
      "readOnly": true,
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "color": {
            "type": "string",
            "description": "Hexadecimal color code, e.g. `#d9534f`"
          }
        }
      }
    },
    "projectName": {
      "type": "string",
      "description": "Name of the project on the provider, e.g. `my-group/my-project`",
      "readOnly": true
    },
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the resource on the provider's website",
      "readOnly": true
    },
    "author": {
      "description": "The user on the provider who created the resource. Null if unknown.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/RepositoryUserModel"
        },
        {
          "type": "null"
        }
      ]
    },
    "externalUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last updated on the provider",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was first synchronized into OpenProject",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last synchronized into OpenProject",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This issue\n\n**Resource**: RepositoryIssue",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "examples": [
    {
      "_type": "RepositoryIssue",
      "_links": {
        "self": {
          "href": "/api/v3/repository_issues/1",
          "title": "Crash when saving"
        }
      },
      "id": 1,
      "displayId": "42",
      "title": "Crash when saving",
      "description": {
        "format": "markdown",
        "raw": "Steps to reproduce...",
        "html": "<p>Steps to reproduce...</p>"
      },
      "state": "opened",
      "labels": [
        {
          "title": "bug",
          "color": "#d9534f"
        }
      ],
      "projectName": "my-group/my-project",
      "webUrl": "https://gitlab.example.com/my-group/my-project/-/issues/42",
      "author": {
        "name": "Jane Doe",
        "username": "jdoe",
        "avatarUrl": "https://gitlab.example.com/uploads/user/avatar/1/avatar.png"
      },
      "externalUpdatedAt": "2026-10-01T12:00:00.000Z",
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:00.000Z"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of the resource within OpenProject",
      "readOnly": true
    },
    "displayId": {
      "type": "string",
      "description": "Identifier of the merge request as displayed by the provider, e.g. `42`",
      "readOnly": true
    },
    "title": {
      "type": "string",
      "description": "Title of the merge request",
      "readOnly": true
    },
    "description": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Formattable"
        },
        {
          "description": "Description of the merge request",
          "readOnly": true
        }
      ]
    },
    "state": {
      "type": "string",
      "description": "State of the merge request as reported by the provider, e.g. `opened`",
      "readOnly": true
    },
    "labels": {
      "type": "array",
      "description": "Labels attached to the resource on the provider",
      "readOnly": true,
      "items": {
        "type": "object",
        "properties": {
          "title": {
            "type": "string"
          },
          "color": {
            "type": "string",
            "description": "Hexadecimal color code, e.g. `#d9534f`"
          }
        }
      }
    },
    "projectName": {
      "type": "string",
      "description": "Name of the project on the provider, e.g. `my-group/my-project`",
      "readOnly": true
    },
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the resource on the provider's website",
      "readOnly": true
    },
    "author": {
      "description": "The user on the provider who created the resource. Null if unknown.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/RepositoryUserModel"
        },
        {
          "type": "null"
        }
      ]
    },
    "externalUpdatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last updated on the provider",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was first synchronized into OpenProject",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last synchronized into OpenProject",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This merge request\n\n**Resource**: RepositoryMergeRequest",
              "readOnly": true
            }
          ]
        },
        "pipelines": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "All of the CI pipelines that ran for this merge request\n\n**Resource**: RepositoryPipelineCollectionModel",
              "readOnly": true
            }
          ]
        },
        "latestPipeline": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The CI pipeline that started last. A pipeline that has not started yet counts as the latest one.\nOmitted if the merge request has no pipelines.\n\n**Resource**: RepositoryPipeline",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "examples": [
    {
      "_type": "RepositoryMergeRequest",
      "_links": {
        "self": {
          "href": "/api/v3/repository_merge_requests/1",
          "title": "Fix crash when saving"
        },
        "pipelines": {
          "href": "/api/v3/repository_merge_requests/1/repository_pipelines"
        },
        "latestPipeline": {
          "href": "/api/v3/repository_pipelines/99",
          "title": "success"
        }
      },
      "id": 1,
      "displayId": "7",
      "title": "Fix crash when saving",
      "description": {
        "format": "markdown",
        "raw": "Fixes OP#1234",
        "html": "<p>Fixes OP#1234</p>"
      },
      "state": "merged",
      "labels": [],
      "projectName": "my-group/my-project",
      "webUrl": "https://gitlab.example.com/my-group/my-project/-/merge_requests/7",
      "author": {
        "name": "Jane Doe",
        "username": "jdoe",
        "avatarUrl": "https://gitlab.example.com/uploads/user/avatar/1/avatar.png"
      },
      "externalUpdatedAt": "2026-10-01T12:00:00.000Z",
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:00:00.000Z"
    }
  ]
}

{
  "type": "object",
  "properties": {
    "id": {
      "type": "integer",
      "description": "Identifier of the resource within OpenProject",
      "readOnly": true
    },
    "status": {
      "type": "string",
      "description": "Status of the pipeline as reported by the provider, e.g. `success`",
      "readOnly": true
    },
    "webUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL of the pipeline on the provider's website",
      "readOnly": true
    },
    "detailsUrl": {
      "type": [
        "string",
        "null"
      ],
      "format": "uri",
      "description": "URL of the pipeline's details (e.g. its jobs) on the provider's website",
      "readOnly": true
    },
    "author": {
      "description": "The user on the provider who triggered the pipeline. Null if unknown.",
      "oneOf": [
        {
          "$ref": "#/components/schemas/RepositoryUserModel"
        },
        {
          "type": "null"
        }
      ]
    },
    "startedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Time the pipeline started. Null if it has not started yet.",
      "readOnly": true
    },
    "completedAt": {
      "type": [
        "string",
        "null"
      ],
      "format": "date-time",
      "description": "Time the pipeline completed. Null if it has not completed yet.",
      "readOnly": true
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was first synchronized into OpenProject",
      "readOnly": true
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "Time the resource was last synchronized into OpenProject",
      "readOnly": true
    },
    "_links": {
      "type": "object",
      "required": [
        "self",
        "mergeRequest"
      ],
      "properties": {
        "self": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "This pipeline\n\n**Resource**: RepositoryPipeline",
              "readOnly": true
            }
          ]
        },
        "mergeRequest": {
          "allOf": [
            {
              "$ref": "#/components/schemas/Link"
            },
            {
              "description": "The merge request the pipeline was run for\n\n**Resource**: RepositoryMergeRequest",
              "readOnly": true
            }
          ]
        }
      }
    }
  },
  "examples": [
    {
      "_type": "RepositoryPipeline",
      "_links": {
        "self": {
          "href": "/api/v3/repository_pipelines/99",
          "title": "success"
        },
        "mergeRequest": {
          "href": "/api/v3/repository_merge_requests/1",
          "title": "Fix crash when saving"
        }
      },
      "id": 99,
      "status": "success",
      "webUrl": "https://gitlab.example.com/my-group/my-project/-/pipelines/99",
      "detailsUrl": "https://gitlab.example.com/my-group/my-project/-/pipelines/99/builds",
      "author": {
        "name": "Jane Doe",
        "username": "jdoe",
        "avatarUrl": "https://gitlab.example.com/uploads/user/avatar/1/avatar.png"
      },
      "startedAt": "2026-10-01T12:00:00.000Z",
      "completedAt": "2026-10-01T12:10:00.000Z",
      "createdAt": "2026-10-01T12:00:00.000Z",
      "updatedAt": "2026-10-01T12:10:00.000Z"
    }
  ]
}