UNPKG

@adobe/helix-shared

Version:

Shared modules of the Helix Project

273 lines (123 loc) 3.55 kB
# Git URL Schema ``` https://ns.adobe.com/helix/shared/staticgiturl ``` Representation of the fragments of a Git URL | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Defined In | |----------|------------|--------|--------------|-------------------|-----------------------|------------| | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | [staticgiturl.schema.json](staticgiturl.schema.json) | # Git URL Properties | Property | Type | Required | Nullable | Default | Defined by | |----------|------|----------|----------|---------|------------| | [allow](#allow) | `string[]` | Optional | No | | Git URL (this schema) | | [deny](#deny) | `string[]` | Optional | No | | Git URL (this schema) | | [host](#host) | `string` | Optional | No | | Git URL (this schema) | | [hostname](#hostname) | `string` | Optional | No | | Git URL (this schema) | | [magic](#magic) | `boolean` | Optional | No | | Git URL (this schema) | | [owner](#owner) | `string` | **Required** | No | | Git URL (this schema) | | [path](#path) | `string` | Optional | No | | Git URL (this schema) | | [port](#port) | multiple | Optional | No | | Git URL (this schema) | | [protocol](#protocol) | `enum` | Optional | No | | Git URL (this schema) | | [ref](#ref) | `string` | **Required** | No | `"master"` | Git URL (this schema) | | [repo](#repo) | `string` | **Required** | No | | Git URL (this schema) | ## allow List of white listed paths `allow` * is optional * type: `string[]` * defined in this schema ### allow Type Array type: `string[]` All items must be of the type: `string` ## deny List of white listed paths `deny` * is optional * type: `string[]` * defined in this schema ### deny Type Array type: `string[]` All items must be of the type: `string` ## host The hostname with port `host` * is optional * type: `string` * defined in this schema ### host Type `string` ## hostname The hostname without port `hostname` * is optional * type: `string` * defined in this schema ### hostname Type `string` * format: `hostname` – Domain Name (according to [RFC 1034, section 3.1](https://tools.ietf.org/html/rfc1034)) ## magic Deprecated: Enable server-side asset processing. `magic` * is optional * type: `boolean` * defined in this schema ### magic Type `boolean` ## owner The owner or username that the repository belongs to `owner` * is **required** * type: `string` * defined in this schema ### owner Type `string` ## path The path within the repository `path` * is optional * type: `string` * defined in this schema ### path Type `string` ## port The port to access the Git Repository `port` * is optional * type: multiple * defined in this schema ### port Type Either one of: * `integer` * `string` ## protocol The protocol to access the Git repository `protocol` * is optional * type: `enum` * defined in this schema The value of this property **must** be equal to one of the [known values below](#protocol-known-values). ### protocol Known Values | Value | Description | |-------|-------------| | `https` | | | `http` | | | `ssh` | | ## ref The branch, tag, or sha of the tree in the repository to use `ref` * is **required** * type: `string` * default: `"master"` * defined in this schema ### ref Type `string` ## repo The repository name `repo` * is **required** * type: `string` * defined in this schema ### repo Type `string`