Showing:

Annotations
Diagram
Properties
Constraints
Used By
Source
Property schema packageDirectories
Annotations
 
Title  Package Directories

Description  Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.
Diagram
properties_packageDirectories.html#/properties/packageDirectories/items diagram
Type array
Constraints
 
Unique Items : false
Array Items
Additional Items false
Used by
Schema
#/schema
Source
 

 "packageDirectories": {
  "type": "array",
  "minItems": 1,
  "additionalItems": false,
  "title": "Package Directories",
  "description": "Package directories indicate which directories to target when syncing source to and from the scratch org. These directories can contain source from your managed package, unmanaged package, or unpackaged source, for example, ant tool or change set.",
  "$comment": "The properties ancestorId & ancestorVersion cannot be included together, but this schema optimizes for VS Code code completion rather than pure validation.",
  "items": {
    "type": "object",
    "dependencies": {
      "ancestorId": [
        "versionNumber",
        "package"
      ],
      "ancestorVersion": [
        "versionNumber",
        "package"
      ],
      "definitionFile": [
        "versionNumber",
        "package"
      ],
      "dependencies": [
        "versionNumber",
        "package"
      ],
      "package": ["versionNumber"],
      "postInstallScript": [
        "versionNumber",
        "package"
      ],
      "postInstallUrl": [
        "versionNumber",
        "package"
      ],
      "releaseNotesUrl": [
        "versionNumber",
        "package"
      ],
      "uninstallScript": [
        "versionNumber",
        "package"
      ],
      "versionDescription": [
        "versionNumber",
        "package"
      ],
      "versionName": [
        "versionNumber",
        "package"
      ],
      "versionNumber": ["package"]
    },
    "additionalProperties": false,
    "required": ["path"],
    "properties": {
      "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"},
      "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"},
      "default": {"$ref": "#/definitions/packageDirectory.default"},
      "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"},
      "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"},
      "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"},
      "package": {"$ref": "#/definitions/packageDirectory.package"},
      "path": {"$ref": "#/definitions/packageDirectory.path"},
      "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"},
      "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"},
      "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"},
      "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"},
      "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"},
      "versionName": {"$ref": "#/definitions/packageDirectory.versionName"},
      "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}
    }
  }
}

Property schema packageDirectories/items
Diagram
#/properties/packageDirectories/items/dependencies properties_packageDirectories.html#/properties/packageDirectories/items/properties/ancestorId properties_packageDirectories.html#/properties/packageDirectories/items/properties/ancestorVersion properties_packageDirectories.html#/properties/packageDirectories/items/properties/default properties_packageDirectories.html#/properties/packageDirectories/items/properties/definitionFile properties_packageDirectories.html#/properties/packageDirectories/items/properties/dependencies properties_packageDirectories.html#/properties/packageDirectories/items/properties/includeProfileUserLicenses properties_packageDirectories.html#/properties/packageDirectories/items/properties/package properties_packageDirectories.html#/properties/packageDirectories/items/properties/path properties_packageDirectories.html#/properties/packageDirectories/items/properties/postInstallScript properties_packageDirectories.html#/properties/packageDirectories/items/properties/postInstallUrl properties_packageDirectories.html#/properties/packageDirectories/items/properties/releaseNotesUrl properties_packageDirectories.html#/properties/packageDirectories/items/properties/uninstallScript properties_packageDirectories.html#/properties/packageDirectories/items/properties/versionDescription properties_packageDirectories.html#/properties/packageDirectories/items/properties/versionName properties_packageDirectories.html#/properties/packageDirectories/items/properties/versionNumber diagram
Type object
Properties
Name Occurrence
ancestorId
ancestorVersion
default
definitionFile
dependencies
includeProfileUserLicenses
package
path
postInstallScript
postInstallUrl
releaseNotesUrl
uninstallScript
versionDescription
versionName
versionNumber
 optional
optional
optional
optional
optional
optional
optional
required
optional
optional
optional
optional
optional
optional
optional
Property Dependencies
Property Dependency
ancestorId
ancestorVersion
definitionFile
dependencies
package
postInstallScript
postInstallUrl
releaseNotesUrl
uninstallScript
versionDescription
versionName
versionNumber
 versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
versionNumber, package
package
Additional Properties false
Used by
Source
 

 "items": {
  "type": "object",
  "dependencies": {
    "ancestorId": [
      "versionNumber",
      "package"
    ],
    "ancestorVersion": [
      "versionNumber",
      "package"
    ],
    "definitionFile": [
      "versionNumber",
      "package"
    ],
    "dependencies": [
      "versionNumber",
      "package"
    ],
    "package": ["versionNumber"],
    "postInstallScript": [
      "versionNumber",
      "package"
    ],
    "postInstallUrl": [
      "versionNumber",
      "package"
    ],
    "releaseNotesUrl": [
      "versionNumber",
      "package"
    ],
    "uninstallScript": [
      "versionNumber",
      "package"
    ],
    "versionDescription": [
      "versionNumber",
      "package"
    ],
    "versionName": [
      "versionNumber",
      "package"
    ],
    "versionNumber": ["package"]
  },
  "additionalProperties": false,
  "required": ["path"],
  "properties": {
    "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"},
    "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"},
    "default": {"$ref": "#/definitions/packageDirectory.default"},
    "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"},
    "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"},
    "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"},
    "package": {"$ref": "#/definitions/packageDirectory.package"},
    "path": {"$ref": "#/definitions/packageDirectory.path"},
    "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"},
    "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"},
    "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"},
    "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"},
    "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"},
    "versionName": {"$ref": "#/definitions/packageDirectory.versionName"},
    "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}
  }
}

Definition schema ancestorId
Diagram
definitions_packageDirectory.ancestorId.html#/definitions/packageDirectory.ancestorId diagram
Type reference
Refers packageDirectory.ancestorId
Used by
Source
 

 "ancestorId": {"$ref": "#/definitions/packageDirectory.ancestorId"}

Definition schema ancestorVersion
Diagram
definitions_packageDirectory.ancestorVersion.html#/definitions/packageDirectory.ancestorVersion diagram
Type reference
Refers packageDirectory.ancestorVersion
Used by
Source
 

 "ancestorVersion": {"$ref": "#/definitions/packageDirectory.ancestorVersion"}

Definition schema default
Diagram
definitions_packageDirectory.default.html#/definitions/packageDirectory.default diagram
Type reference
Refers packageDirectory.default
Used by
Source
 

 "default": {"$ref": "#/definitions/packageDirectory.default"}

Definition schema definitionFile
Diagram
definitions_packageDirectory.definitionFile.html#/definitions/packageDirectory.definitionFile diagram
Type reference
Refers packageDirectory.definitionFile
Used by
Source
 

 "definitionFile": {"$ref": "#/definitions/packageDirectory.definitionFile"}

Definition schema dependencies
Diagram
definitions_packageDirectory.dependencies.html#/definitions/packageDirectory.dependencies diagram
Type reference
Refers packageDirectory.dependencies
Used by
Source
 

 "dependencies": {"$ref": "#/definitions/packageDirectory.dependencies"}

Definition schema includeProfileUserLicenses
Diagram
definitions_packageDirectory.includeProfileUserLicenses.html#/definitions/packageDirectory.includeProfileUserLicenses diagram
Type reference
Refers packageDirectory.includeProfileUserLicenses
Used by
Source
 

 "includeProfileUserLicenses": {"$ref": "#/definitions/packageDirectory.includeProfileUserLicenses"}

Definition schema package
Diagram
definitions_packageDirectory.package.html#/definitions/packageDirectory.package diagram
Type reference
Refers packageDirectory.package
Used by
Source
 

 "package": {"$ref": "#/definitions/packageDirectory.package"}

Definition schema path
Diagram
definitions_packageDirectory.path.html#/definitions/packageDirectory.path diagram
Type reference
Refers packageDirectory.path
Used by
Source
 

 "path": {"$ref": "#/definitions/packageDirectory.path"}

Definition schema postInstallScript
Diagram
definitions_packageDirectory.postInstallScript.html#/definitions/packageDirectory.postInstallScript diagram
Type reference
Refers packageDirectory.postInstallScript
Used by
Source
 

 "postInstallScript": {"$ref": "#/definitions/packageDirectory.postInstallScript"}

Definition schema postInstallUrl
Diagram
definitions_packageDirectory.postInstallUrl.html#/definitions/packageDirectory.postInstallUrl diagram
Type reference
Refers packageDirectory.postInstallUrl
Used by
Source
 

 "postInstallUrl": {"$ref": "#/definitions/packageDirectory.postInstallUrl"}

Definition schema releaseNotesUrl
Diagram
definitions_packageDirectory.releaseNotesUrl.html#/definitions/packageDirectory.releaseNotesUrl diagram
Type reference
Refers packageDirectory.releaseNotesUrl
Used by
Source
 

 "releaseNotesUrl": {"$ref": "#/definitions/packageDirectory.releaseNotesUrl"}

Definition schema uninstallScript
Diagram
definitions_packageDirectory.uninstallScript.html#/definitions/packageDirectory.uninstallScript diagram
Type reference
Refers packageDirectory.uninstallScript
Used by
Source
 

 "uninstallScript": {"$ref": "#/definitions/packageDirectory.uninstallScript"}

Definition schema versionDescription
Diagram
definitions_packageDirectory.versionDescription.html#/definitions/packageDirectory.versionDescription diagram
Type reference
Refers packageDirectory.versionDescription
Used by
Source
 

 "versionDescription": {"$ref": "#/definitions/packageDirectory.versionDescription"}

Definition schema versionName
Diagram
definitions_packageDirectory.versionName.html#/definitions/packageDirectory.versionName diagram
Type reference
Refers packageDirectory.versionName
Used by
Source
 

 "versionName": {"$ref": "#/definitions/packageDirectory.versionName"}

Definition schema versionNumber
Diagram
definitions_packageDirectory.versionNumber.html#/definitions/packageDirectory.versionNumber diagram
Type reference
Refers packageDirectory.versionNumber
Used by
Source
 

 "versionNumber": {"$ref": "#/definitions/packageDirectory.versionNumber"}

JSON Schema documentation generated by ®