Team Repository

A team's access to a repository.

APIs.ioEngineeringPlatform

Properties

Name Type Description
id integer Unique identifier of the repository
node_id string
name string The name of the repository.
full_name string
license object
forks integer
permissions object
role_name string
owner object
private boolean Whether the repository is private or public.
html_url string
description string
fork boolean
url string
archive_url string
assignees_url string
blobs_url string
branches_url string
collaborators_url string
comments_url string
commits_url string
compare_url string
contents_url string
contributors_url string
deployments_url string
downloads_url string
events_url string
forks_url string
git_commits_url string
git_refs_url string
git_tags_url string
git_url string
issue_comment_url string
issue_events_url string
issues_url string
keys_url string
labels_url string
languages_url string
merges_url string
milestones_url string
notifications_url string
pulls_url string
releases_url string
ssh_url string
stargazers_url string
statuses_url string
subscribers_url string
subscription_url string
tags_url string
teams_url string
trees_url string
clone_url string
mirror_url string
hooks_url string
svn_url string
homepage string
language string
forks_count integer
stargazers_count integer
watchers_count integer
size integer
default_branch string The default branch of the repository.
open_issues_count integer
is_template boolean Whether this repository acts as a template that can be used to generate new repositories.
topics array
has_issues boolean Whether issues are enabled.
has_projects boolean Whether projects are enabled.
has_wiki boolean Whether the wiki is enabled.
has_pages boolean
has_downloads boolean Whether downloads are enabled.
archived boolean Whether the repository is archived.
disabled boolean Returns whether or not this repository disabled.
visibility string The repository visibility: public, private, or internal.
pushed_at string
created_at string
updated_at string
allow_rebase_merge boolean Whether to allow rebase merges for pull requests.
temp_clone_token string
allow_squash_merge boolean Whether to allow squash merges for pull requests.
allow_auto_merge boolean Whether to allow Auto-merge to be used on pull requests.
delete_branch_on_merge boolean Whether to delete head branches when pull requests are merged
allow_merge_commit boolean Whether to allow merge commits for pull requests.
allow_forking boolean Whether to allow forking this repo
web_commit_signoff_required boolean Whether to require contributors to sign off on web-based commits
subscribers_count integer
network_count integer
open_issues integer
watchers integer
master_branch string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-team-repository-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/team-repository",
  "title": "Team Repository",
  "description": "A team's access to a repository.",
  "type": "object",
  "properties": {
    "id": {
      "description": "Unique identifier of the repository",
      "example": 42,
      "type": "integer"
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
    },
    "name": {
      "description": "The name of the repository.",
      "type": "string",
      "example": "Team Environment"
    },
    "full_name": {
      "type": "string",
      "example": "octocat/Hello-World"
    },
    "license": {
      "$ref": "#/components/schemas/nullable-license-simple"
    },
    "forks": {
      "type": "integer"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "admin": {
          "type": "boolean"
        },
        "pull": {
          "type": "boolean"
        },
        "triage": {
          "type": "boolean"
        },
        "push": {
          "type": "boolean"
        },
        "maintain": {
          "type": "boolean"
        }
      },
      "required": [
        "admin",
        "pull",
        "push"
      ]
    },
    "role_name": {
      "type": "string",
      "example": "admin"
    },
    "owner": {
      "$ref": "#/components/schemas/nullable-simple-user"
    },
    "private": {
      "description": "Whether the repository is private or public.",
      "default": false,
      "type": "boolean"
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com/octocat/Hello-World"
    },
    "description": {
      "type": "string",
      "example": "This your first repo!",
      "nullable": true
    },
    "fork": {
      "type": "boolean"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "example": "https://api.github.com/repos/octocat/Hello-World"
    },
    "archive_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}"
    },
    "assignees_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}"
    },
    "blobs_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}"
    },
    "branches_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}"
    },
    "collaborators_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}"
    },
    "comments_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}"
    },
    "commits_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}"
    },
    "compare_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}"
    },
    "contents_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}"
    },
    "contributors_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
    },
    "deployments_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
    },
    "downloads_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
    },
    "events_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/events"
    },
    "forks_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/forks"
    },
    "git_commits_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}"
    },
    "git_refs_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}"
    },
    "git_tags_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}"
    },
    "git_url": {
      "type": "string",
      "example": "git:github.com/octocat/Hello-World.git"
    },
    "issue_comment_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}"
    },
    "issue_events_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}"
    },
    "issues_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}"
    },
    "keys_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}"
    },
    "labels_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}"
    },
    "languages_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/languages"
    },
    "merges_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/merges"
    },
    "milestones_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}"
    },
    "notifications_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}"
    },
    "pulls_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}"
    },
    "releases_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}"
    },
    "ssh_url": {
      "type": "string",
      "example": "[email protected]:octocat/Hello-World.git"
    },
    "stargazers_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/stargazers"
    },
    "statuses_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}"
    },
    "subscribers_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
    },
    "subscription_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
    },
    "tags_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/tags"
    },
    "teams_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/teams"
    },
    "trees_url": {
      "type": "string",
      "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}"
    },
    "clone_url": {
      "type": "string",
      "example": "https://github.com/octocat/Hello-World.git"
    },
    "mirror_url": {
      "type": "string",
      "format": "uri",
      "example": "git:git.example.com/octocat/Hello-World",
      "nullable": true
    },
    "hooks_url": {
      "type": "string",
      "format": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
    },
    "svn_url": {
      "type": "string",
      "format": "uri",
      "example": "https://svn.github.com/octocat/Hello-World"
    },
    "homepage": {
      "type": "string",
      "format": "uri",
      "example": "https://github.com",
      "nullable": true
    },
    "language": {
      "type": "string",
      "nullable": true
    },
    "forks_count": {
      "type": "integer",
      "example": 9
    },
    "stargazers_count": {
      "type": "integer",
      "example": 80
    },
    "watchers_count": {
      "type": "integer",
      "example": 80
    },
    "size": {
      "type": "integer",
      "example": 108
    },
    "default_branch": {
      "description": "The default branch of the repository.",
      "type": "string",
      "example": "master"
    },
    "open_issues_count": {
      "type": "integer",
      "example": 0
    },
    "is_template": {
      "description": "Whether this repository acts as a template that can be used to generate new repositories.",
      "default": false,
      "type": "boolean",
      "example": true
    },
    "topics": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "has_issues": {
      "description": "Whether issues are enabled.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "has_projects": {
      "description": "Whether projects are enabled.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "has_wiki": {
      "description": "Whether the wiki is enabled.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "has_pages": {
      "type": "boolean"
    },
    "has_downloads": {
      "description": "Whether downloads are enabled.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "archived": {
      "description": "Whether the repository is archived.",
      "default": false,
      "type": "boolean"
    },
    "disabled": {
      "type": "boolean",
      "description": "Returns whether or not this repository disabled."
    },
    "visibility": {
      "description": "The repository visibility: public, private, or internal.",
      "default": "public",
      "type": "string"
    },
    "pushed_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:06:43Z",
      "nullable": true
    },
    "created_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:01:12Z",
      "nullable": true
    },
    "updated_at": {
      "type": "string",
      "format": "date-time",
      "example": "2011-01-26T19:14:43Z",
      "nullable": true
    },
    "allow_rebase_merge": {
      "description": "Whether to allow rebase merges for pull requests.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "temp_clone_token": {
      "type": "string"
    },
    "allow_squash_merge": {
      "description": "Whether to allow squash merges for pull requests.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "allow_auto_merge": {
      "description": "Whether to allow Auto-merge to be used on pull requests.",
      "default": false,
      "type": "boolean",
      "example": false
    },
    "delete_branch_on_merge": {
      "description": "Whether to delete head branches when pull requests are merged",
      "default": false,
      "type": "boolean",
      "example": false
    },
    "allow_merge_commit": {
      "description": "Whether to allow merge commits for pull requests.",
      "default": true,
      "type": "boolean",
      "example": true
    },
    "allow_forking": {
      "description": "Whether to allow forking this repo",
      "default": false,
      "type": "boolean",
      "example": false
    },
    "web_commit_signoff_required": {
      "description": "Whether to require contributors to sign off on web-based commits",
      "default": false,
      "type": "boolean",
      "example": false
    },
    "subscribers_count": {
      "type": "integer"
    },
    "network_count": {
      "type": "integer"
    },
    "open_issues": {
      "type": "integer"
    },
    "watchers": {
      "type": "integer"
    },
    "master_branch": {
      "type": "string"
    }
  },
  "required": [
    "archive_url",
    "assignees_url",
    "blobs_url",
    "branches_url",
    "collaborators_url",
    "comments_url",
    "commits_url",
    "compare_url",
    "contents_url",
    "contributors_url",
    "deployments_url",
    "description",
    "downloads_url",
    "events_url",
    "fork",
    "forks_url",
    "full_name",
    "git_commits_url",
    "git_refs_url",
    "git_tags_url",
    "hooks_url",
    "html_url",
    "id",
    "node_id",
    "issue_comment_url",
    "issue_events_url",
    "issues_url",
    "keys_url",
    "labels_url",
    "languages_url",
    "merges_url",
    "milestones_url",
    "name",
    "notifications_url",
    "owner",
    "private",
    "pulls_url",
    "releases_url",
    "stargazers_url",
    "statuses_url",
    "subscribers_url",
    "subscription_url",
    "tags_url",
    "teams_url",
    "trees_url",
    "url",
    "clone_url",
    "default_branch",
    "forks",
    "forks_count",
    "git_url",
    "has_downloads",
    "has_issues",
    "has_projects",
    "has_wiki",
    "has_pages",
    "homepage",
    "language",
    "archived",
    "disabled",
    "mirror_url",
    "open_issues",
    "open_issues_count",
    "license",
    "pushed_at",
    "size",
    "ssh_url",
    "stargazers_count",
    "svn_url",
    "watchers",
    "watchers_count",
    "created_at",
    "updated_at"
  ]
}