Skip to content

Latest commit

 

History

History
449 lines (217 loc) · 10.4 KB

descriptorOneToOne.schema.md

File metadata and controls

449 lines (217 loc) · 10.4 KB

One to One Relationship Descriptor Schema

https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne

Describes one to one relationship descriptor.

Abstract Extensible Status Identifiable Custom Properties Additional Properties Defined In
Can be instantiated Yes Stable No Forbidden Permitted descriptors/relationship/descriptorOneToOne.schema.json

Schema Hierarchy

  • One to One Relationship Descriptor https://ns.adobe.com/xdm/common/descriptors/descriptorOneToOne

One to One Relationship Descriptor Example

{
  "@id": "https://ns.adobe.com/example/descriptorOneToOne/1",
  "@type": "xdm:descriptorOneToOne",
  "xdm:sourceSchema": "https://ns.adobe.com/experience/aem/user",
  "xdm:sourceVersion": 1,
  "xdm:destinationSchema": "https://ns.adobe.com/xdm/context/profile",
  "xdm:destinationVersion": 1,
  "xdm:label": "UserProfile"
}

One to One Relationship Descriptor Properties

Property Type Required Default Defined by
@id string Optional Schema Descriptor
@type const Optional One to One Relationship Descriptor (this schema)
xdm:cardinality enum Optional "M:1" Relationship Descriptor
xdm:destinationItem complex Optional Relationship Descriptor
xdm:destinationNamespace string Optional Relationship Descriptor
xdm:destinationProperty complex Optional Relationship Descriptor
xdm:destinationSchema string Optional Relationship Descriptor
xdm:destinationToSourceTitle string Optional Relationship Descriptor
xdm:destinationVersion number Optional Relationship Descriptor
xdm:sourceItem complex Optional Schema Descriptor
xdm:sourceNamespace string Optional Relationship Descriptor
xdm:sourceProperty complex Optional Schema Descriptor
xdm:sourceSchema string Optional Schema Descriptor
xdm:sourceToDestinationTitle string Optional Relationship Descriptor
xdm:sourceValue string Optional Relationship Descriptor
xdm:sourceVersion number Optional Schema Descriptor
* any Additional this schema allows additional properties

@id

Identifier

The unique identifier for the schema descriptor. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'.

@id

@id Type

string

  • format: uri-reference – URI Reference (according to RFC3986)

@type

@type

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

The value of this property must be equal to:

"xdm:descriptorOneToOne"

xdm:cardinality

Relationship Cardinality

Source to Destination cardinality

xdm:cardinality

The value of this property must be equal to one of the known values below.

xdm:cardinality Known Values

Value Description
M:1

xdm:destinationItem

Destination Item

When present, the selector used to match a specific item in the array pointed to by destProperty

xdm:destinationItem

xdm:destinationItem Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Condition 3

Condition 4

xdm:destinationNamespace

Source Property Namespace

Identity Service namespace associated with the source property

xdm:destinationNamespace

xdm:destinationNamespace Type

string

xdm:destinationProperty

Destination Property

When present, the property of the destination schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by 'xdm:destSchema'

xdm:destinationProperty

xdm:destinationProperty Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

xdm:destinationSchema

Destination Schema

The destination schema this descriptor applies to

xdm:destinationSchema

xdm:destinationSchema Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:destinationToSourceTitle

Destination to Source Title

Provides a user friendly title for the destination->source edge

xdm:destinationToSourceTitle

xdm:destinationToSourceTitle Type

string

  • maximum length: 35 characters

xdm:destinationVersion

Destination Version

Major version being referenced.

xdm:destinationVersion

xdm:destinationVersion Type

number

xdm:sourceItem

Source Item

When present, the selector used to match a specific item in the array pointed to by sourceProperty.

xdm:sourceItem

xdm:sourceItem Type

One of the following conditions need to be fulfilled.

Condition 1

Condition 2

Condition 3

Condition 4

xdm:sourceNamespace

Source Property Namespace

Identity Service namespace associated with the source property

xdm:sourceNamespace

xdm:sourceNamespace Type

string

xdm:sourceProperty

Source Property

When present, the property of the source schema to which this descriptor applies. This value is a JSON Pointer, applied to an instance of an object described by xdm:sourceSchema.

xdm:sourceProperty

xdm:sourceProperty Type

One of the following conditions need to be fulfilled.

Condition 1

string

Condition 2

Array type:

All items must be of the type: string

xdm:sourceSchema

Source Schema

The source schema this descriptor applies to. This property is required when the descriptor is defined outside of the applicable schema, but is optional when applied via 'meta:descriptors'

xdm:sourceSchema

xdm:sourceSchema Type

string

  • format: uri – Uniformous Resource Identifier (according to RFC3986)

xdm:sourceToDestinationTitle

Source to Destination Title

Provides a user friendly title for the source->destination edge

xdm:sourceToDestinationTitle

xdm:sourceToDestinationTitle Type

string

  • maximum length: 35 characters

xdm:sourceValue

Source Value

When present, provides additional information about the values in that field. Descriptor producer and consumer should coordinate on how to use this field, e.g. defining rules on formats, values, and operations.

xdm:sourceValue

xdm:sourceValue Type

string

xdm:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

xdm:sourceVersion Type

number