Forgejo · Schema

ContentsResponse

ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content

GitSource Code ManagementSelf-HostedDevOpsCI/CDOpen SourceForgeRepositoriesIssuesPull Requests

Properties

Name	Type	Description
_links	object
content	string	`content` is populated when `type` is `file`, otherwise null
download_url	string
encoding	string	`encoding` is populated when `type` is `file`, otherwise null
git_url	string
html_url	string
last_commit_sha	string
last_commit_when	string
name	string
path	string
sha	string
size	integer
submodule_git_url	string	`submodule_git_url` is populated when `type` is `submodule`, otherwise null
target	string	`target` is populated when `type` is `symlink`, otherwise null
type	string	`type` will be `file`, `dir`, `symlink`, or `submodule`
url	string

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "title": "ContentsResponse",
  "description": "ContentsResponse contains information about a repo's entry's (dir, file, symlink, submodule) metadata and content",
  "type": "object",
  "properties": {
    "_links": {
      "$ref": "#/definitions/FileLinksResponse"
    },
    "content": {
      "description": "`content` is populated when `type` is `file`, otherwise null",
      "type": "string",
      "x-go-name": "Content"
    },
    "download_url": {
      "type": "string",
      "x-go-name": "DownloadURL"
    },
    "encoding": {
      "description": "`encoding` is populated when `type` is `file`, otherwise null",
      "type": "string",
      "x-go-name": "Encoding"
    },
    "git_url": {
      "type": "string",
      "x-go-name": "GitURL"
    },
    "html_url": {
      "type": "string",
      "x-go-name": "HTMLURL"
    },
    "last_commit_sha": {
      "type": "string",
      "x-go-name": "LastCommitSHA"
    },
    "last_commit_when": {
      "type": "string",
      "format": "date-time",
      "x-go-name": "LastCommitWhen"
    },
    "name": {
      "type": "string",
      "x-go-name": "Name"
    },
    "path": {
      "type": "string",
      "x-go-name": "Path"
    },
    "sha": {
      "type": "string",
      "x-go-name": "SHA"
    },
    "size": {
      "type": "integer",
      "format": "int64",
      "x-go-name": "Size"
    },
    "submodule_git_url": {
      "description": "`submodule_git_url` is populated when `type` is `submodule`, otherwise null",
      "type": "string",
      "x-go-name": "SubmoduleGitURL"
    },
    "target": {
      "description": "`target` is populated when `type` is `symlink`, otherwise null",
      "type": "string",
      "x-go-name": "Target"
    },
    "type": {
      "description": "`type` will be `file`, `dir`, `symlink`, or `submodule`",
      "type": "string",
      "x-go-name": "Type"
    },
    "url": {
      "type": "string",
      "x-go-name": "URL"
    }
  },
  "x-go-package": "forgejo.org/modules/structs"
}