Skip to content

Latest commit

 

History

History
312 lines (187 loc) · 7.75 KB

directory.schema.md

File metadata and controls

312 lines (187 loc) · 7.75 KB

Directory Schema

http://ns.adobe.com/adobecloud/core/1.0/directory

A directory in Adobe Cloud Platform.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Experimental No Forbidden Permitted external/repo/directory.schema.json

Schema Hierarchy

  • Directory http://ns.adobe.com/adobecloud/core/1.0/directory

Directory Examples

{
  "_links": {
    "http://ns.adobe.com/adobecloud/rel/create": {
      "href": "https://api.example.com/v2/create{+path}{?intermediates}",
      "templated": true
    },
    "http://ns.adobe.com/adobecloud/rel/resolve/id": {
      "href": "https://api2.example.com/v7/resolve{?asset_id}",
      "templated": true
    }
  },
  "_page": {
    "orderBy": "id",
    "start": "123",
    "next": "789",
    "count": 100
  },
  "repo:createdDate": "2017-09-26T15:52:25+00:00",
  "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00",
  "repo:path": "/",
  "repo:name": "here",
  "repo:etag": "15",
  "dc:format": "application/vnd.adobecloud.directory+json",
  "children": []
}
{
  "_links": {
    "http://ns.adobe.com/adobecloud/rel/create": {
      "href": "https://api.example.com/v2/create{+path}{?intermediates}",
      "templated": true
    },
    "http://ns.adobe.com/adobecloud/rel/resolve/id": {
      "href": "https://api2.example.com/v7/resolve{?asset_id}",
      "templated": true
    }
  },
  "repo:createdDate": "2017-09-26T15:52:25+00:00",
  "repo:lastModifiedDate": "2017-09-26T15:52:25+00:00",
  "repo:path": "/",
  "repo:name": "here",
  "repo:etag": "15",
  "dc:format": "application/vnd.adobecloud.directory+json",
  "children": []
}

Directory Properties

Property Type Required Defined by
_embedded object Optional HAL Resource
_links object Optional HAL Resource
_page Page Optional Directory (this schema)
children array Optional Directory (this schema)
dc:format string Required Common Properties
repo:createDate string Optional Common Properties
repo:lastModifiedDate string Required Common Properties
repo:name string Required Common Properties
repo:path string Required Common Properties
* any Additional this schema allows additional properties

_embedded

It is an object whose property names are link relation types (as defined by RFC5988) and values are either a Resource Object or an array of Resource Objects.\n\nEmbedded Resources MAY be a full, partial, or inconsistent version of the representation served from the target URI.

_embedded

_embedded Type

object with following properties:

Property Type Required

_links

It is an object whose property names are link relation types (as defined by RFC5988 and values are either a Link Object or an array of Link Objects. The subject resource of these links is the Resource Object of which the containing _links object is a property.

_links

_links Type

object with following properties:

Property Type Required

_page

Page info, included if this resource is part of paginated result.

_page

  • is optional
  • type: Page
  • defined in this schema

_page Type

  • Page – https://ns.adobe.com/xdm/common/page

children

children

  • is optional

  • type: array

  • defined in this schema

children Type

Array type: array

All items must be of the type: Unknown type ``.

{
  "type": "array",
  "items": {
    "oneOf": [
      {
        "$ref": "http://ns.adobe.com/adobecloud/core/1.0/sub-directory"
      },
      {
        "$ref": "http://ns.adobe.com/adobecloud/core/1.0/asset"
      }
    ],
    "simpletype": "complex"
  },
  "simpletype": "`array`"
}

dc:format

Format

The physical or digital manifestation of the resource. Typically, Format should include the media-type of the resource. Format may be used to determine the software, hardware or other equipment needed to display or operate the resource. Recommended best practice is to select a value from a controlled vocabulary (for example, the list of [Internet Media Types](http://www.iana.org/ assignments/media-types/) defining computer media formats).

dc:format

  • is required
  • type: string
  • defined in Common Properties

dc:format Type

string

All instances must conform to this regular expression

\w+\/[-.\w]+(?:\+[-.\w]+)?

dc:format Example

"application/vnd.adobe.photoshop"

repo:createDate

The server date and time when the resource was created in the repository, such as when an asset file is first uploaded or a directory is created by the server as the parent of a new asset. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:createDate

  • is optional
  • type: string
  • defined in Common Properties

repo:createDate Type

string

repo:createDate Example

"2004-10-23T12:00:00-06:00"

repo:lastModifiedDate

The server date and time when the resource was most recently modified in the repository, such as when a new version of an asset is uploaded or a directory's child resource is added or removed. The Date Time property should conform to ISO 8601 standard. An example form is "2004-10-23T12:00:00-06:00".

repo:lastModifiedDate

  • is required
  • type: string
  • defined in Common Properties

repo:lastModifiedDate Type

string

repo:lastModifiedDate Example

"2004-10-23T12:00:00-06:00"

repo:name

repo:name

  • is required
  • type: string
  • defined in Common Properties

repo:name Type

string

repo:path

repo:path

  • is required
  • type: string
  • defined in Common Properties

repo:path Type

string