ATathenian
settings
default

List the currently configured logical repositories. A logical repository is a set of rules to match PRs, releases, and deployments that has a name and pretends to be a regular GitHub repository everywhere in UI and API requests. This feature is particularly useful to reap monorepos into separate, joint or disjoint parts.

get/settings/logical_repositories/{id}

Request

Path parameters

idinteger required

Numeric identifier of the account.

Response

Configured logical repositories belonging to the account.

namestring required

The logical part of the repository name. Compared to GitHub repository name requirements, we additionally allow / to express the hierarchy further.

parentstring required

Repository name which uniquely identifies any repository in any service provider. The format matches the repository URL without the protocol part. No ".git" should be appended. We support a special syntax for repository sets: "{reposet id}" adds all the repositories from the given set.

Example response

[
  {
    "prs": {
      "title": ".*[Cc]omponent [Aa]lpha",
      "labels_include": [
        "alpha",
        "webapp"
      ]
    },
    "parent": "github.com/athenianco/athenian-monorepo",
    "deployments": {},
    "name": "Webapp",
    "releases": {
      "branches": "{{ \"{{default}}\" }}",
      "tags": "webapp-.*",
      "match": "tag"
    }
  }
]

Changes

No recorded changes to this operation across all 70 revisions of this API.