Content File

Content File

APIs.ioEngineeringPlatform

Properties

Name Type Description
type string
encoding string
size integer
name string
path string
content string
sha string
url string
git_url string
html_url string
download_url string
_links object
target string
submodule_git_url string
View JSON Schema on GitHub

JSON Schema

apis-io-engineering-platform-content-file-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/content-file",
  "title": "Content File",
  "description": "Content File",
  "type": "object",
  "properties": {
    "type": {
      "type": "string",
      "enum": [
        "file"
      ]
    },
    "encoding": {
      "type": "string"
    },
    "size": {
      "type": "integer"
    },
    "name": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "content": {
      "type": "string"
    },
    "sha": {
      "type": "string"
    },
    "url": {
      "type": "string",
      "format": "uri"
    },
    "git_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "html_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "download_url": {
      "type": "string",
      "format": "uri",
      "nullable": true
    },
    "_links": {
      "type": "object",
      "properties": {
        "git": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "html": {
          "type": "string",
          "format": "uri",
          "nullable": true
        },
        "self": {
          "type": "string",
          "format": "uri"
        }
      },
      "required": [
        "git",
        "html",
        "self"
      ]
    },
    "target": {
      "type": "string",
      "example": "\"actual/actual.md\""
    },
    "submodule_git_url": {
      "type": "string",
      "example": "\"git://example.com/defunkt/dotjs.git\""
    }
  },
  "required": [
    "_links",
    "git_url",
    "html_url",
    "download_url",
    "name",
    "path",
    "sha",
    "size",
    "type",
    "url",
    "content",
    "encoding"
  ]
}