settings
default

🛡️👤 Insert or update a logical repository - a named set of rules to match PRs, releases, and deployments that pretends to be a regular GitHub repository everywhere in UI and API requests.

put/settings/logical_repository

Request

Request body

accountinteger required

Account ID.

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 request

{
  "account": 1,
  "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"
  }
}

Response

Created or updated logical repository.

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 90 revisions of this API.