GitHub · JSON Structure

Github Repo Invitations Api Minimal Repository Structure

Minimal Repository

Type: object Properties: 87 Required: 46
CodePipelinesPlatformSoftware DevelopmentSource ControlT1

minimal-repository is a JSON Structure definition published by GitHub, describing 87 properties, of which 46 are required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id node_id name full_name owner private html_url description fork url archive_url assignees_url blobs_url branches_url collaborators_url comments_url commits_url compare_url contents_url contributors_url deployments_url downloads_url events_url forks_url git_commits_url git_refs_url git_tags_url git_url issue_comment_url issue_events_url issues_url keys_url labels_url languages_url merges_url milestones_url notifications_url pulls_url releases_url ssh_url stargazers_url statuses_url subscribers_url subscription_url tags_url teams_url trees_url clone_url mirror_url hooks_url

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/github/refs/heads/main/json-structure/github-repo-invitations-api-minimal-repository-structure.json",
  "name": "minimal-repository",
  "description": "Minimal Repository",
  "type": "object",
  "properties": {
    "id": {
      "type": "int64",
      "example": 1296269
    },
    "node_id": {
      "type": "string",
      "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5"
    },
    "name": {
      "type": "string",
      "example": "Hello-World"
    },
    "full_name": {
      "type": "string",
      "example": "octocat/Hello-World"
    },
    "owner": {
      "$ref": "#/components/schemas/simple-user"
    },
    "private": {
      "type": "boolean",
      "example": true
    },
    "html_url": {
      "type": "uri",
      "example": "https://github.com/octocat/Hello-World"
    },
    "description": {
      "type": "string",
      "example": "This your first repo!"
    },
    "fork": {
      "type": "boolean",
      "example": true
    },
    "url": {
      "type": "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": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/contributors"
    },
    "deployments_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/deployments"
    },
    "downloads_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/downloads"
    },
    "events_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/events"
    },
    "forks_url": {
      "type": "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"
    },
    "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": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/languages"
    },
    "merges_url": {
      "type": "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"
    },
    "stargazers_url": {
      "type": "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": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/subscribers"
    },
    "subscription_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/subscription"
    },
    "tags_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/tags"
    },
    "teams_url": {
      "type": "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"
    },
    "mirror_url": {
      "type": "string"
    },
    "hooks_url": {
      "type": "uri",
      "example": "http://api.github.com/repos/octocat/Hello-World/hooks"
    },
    "svn_url": {
      "type": "string"
    },
    "homepage": {
      "type": "string"
    },
    "language": {
      "type": "string"
    },
    "forks_count": {
      "type": "int32"
    },
    "stargazers_count": {
      "type": "int32"
    },
    "watchers_count": {
      "type": "int32"
    },
    "size": {
      "description": "The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.",
      "type": "int32"
    },
    "default_branch": {
      "type": "string"
    },
    "open_issues_count": {
      "type": "int32"
    },
    "is_template": {
      "type": "boolean"
    },
    "topics": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "has_issues": {
      "type": "boolean"
    },
    "has_projects": {
      "type": "boolean"
    },
    "has_wiki": {
      "type": "boolean"
    },
    "has_pages": {
      "type": "boolean"
    },
    "has_downloads": {
      "type": "boolean"
    },
    "has_discussions": {
      "type": "boolean"
    },
    "archived": {
      "type": "boolean"
    },
    "disabled": {
      "type": "boolean"
    },
    "visibility": {
      "type": "string"
    },
    "pushed_at": {
      "type": "datetime",
      "example": "2011-01-26T19:06:43Z"
    },
    "created_at": {
      "type": "datetime",
      "example": "2011-01-26T19:01:12Z"
    },
    "updated_at": {
      "type": "datetime",
      "example": "2011-01-26T19:14:43Z"
    },
    "permissions": {
      "type": "object",
      "properties": {
        "admin": {
          "type": "boolean"
        },
        "maintain": {
          "type": "boolean"
        },
        "push": {
          "type": "boolean"
        },
        "triage": {
          "type": "boolean"
        },
        "pull": {
          "type": "boolean"
        }
      }
    },
    "role_name": {
      "type": "string",
      "example": "admin"
    },
    "temp_clone_token": {
      "type": "string"
    },
    "delete_branch_on_merge": {
      "type": "boolean"
    },
    "subscribers_count": {
      "type": "int32"
    },
    "network_count": {
      "type": "int32"
    },
    "code_of_conduct": {
      "$ref": "#/components/schemas/code-of-conduct"
    },
    "license": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "spdx_id": {
          "type": "string"
        },
        "url": {
          "type": "string"
        },
        "node_id": {
          "type": "string"
        }
      }
    },
    "forks": {
      "type": "int32",
      "example": 0
    },
    "open_issues": {
      "type": "int32",
      "example": 0
    },
    "watchers": {
      "type": "int32",
      "example": 0
    },
    "allow_forking": {
      "type": "boolean"
    },
    "web_commit_signoff_required": {
      "type": "boolean",
      "example": false
    },
    "security_and_analysis": {
      "$ref": "#/components/schemas/security-and-analysis"
    }
  },
  "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"
  ]
}