Skip to content

alternateDisplayInfo.schema.md

Latest commit

 

History

History
350 lines (185 loc) · 7.33 KB

alternateDisplayInfo.schema.md

File metadata and controls

350 lines (185 loc) · 7.33 KB
Raw

Friendly Name Descriptor Schema

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

Allows to modify the "title" and "description" values of the core library schema fields. UI can use these to show a more friendly name for a standard field or to only show fields that have friendly names.

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

Schema Hierarchy

  • Friendly Name Descriptor https://ns.adobe.com/xdm/common/descriptors/alternateDisplayInfo

Friendly Name Descriptor Examples

{
  "@type": "xdm:alternateDisplayInfo",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/browserDetails",
  "xdm:title": {
    "en_us": "friendly title for browser details"
  },
  "xdm:description": {
    "en_us": "friendly description for browser details"
  }
}
{
  "@type": "xdm:alternateDisplayInfo",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/browserDetails",
  "xdm:title": {
    "en_us": "friendly title for browser details",
    "fr_ca": "titre convivial pour les détails du navigateur"
  }
}
{
  "@type": "xdm:alternateDisplayInfo",
  "xdm:sourceSchema": "https://ns.adobe.com/xdm/context/environment",
  "xdm:sourceVersion": 1,
  "xdm:sourceProperty": "/browserDetails",
  "xdm:description": {
    "en_us": "friendly description for browser details",
    "fr_ca": "description conviviale pour les détails du navigateur"
  }
}

Friendly Name Descriptor Properties

Property Type Required Defined by
@id string Optional Schema Descriptor
@type const Optional Friendly Name Descriptor (this schema)
meta:enum object Optional Friendly Name Descriptor (this schema)
xdm:description object Optional Friendly Name Descriptor (this schema)
xdm:excludeMetaEnum object Optional Friendly Name Descriptor (this schema)
xdm:note object Optional Friendly Name Descriptor (this schema)
xdm:sourceItem complex Optional Schema Descriptor
xdm:sourceProperty complex Optional Schema Descriptor
xdm:sourceSchema string Optional Schema Descriptor
xdm:sourceVersion number Optional Schema Descriptor
xdm:title object Optional Friendly Name Descriptor (this schema)
* 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

@type

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

The value of this property must be equal to:

"xdm:alternateDisplayInfo"

meta:enum

Extended meta:enum values

meta:enum

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

meta:enum Type

object with following properties:

Property Type Required

xdm:description

Description

When present, user friendly description to display.

xdm:description

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

xdm:description Type

object with following properties:

Property Type Required

xdm:excludeMetaEnum

Exclude meta:enum values

xdm:excludeMetaEnum

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

xdm:excludeMetaEnum Type

object with following properties:

Property Type Required

xdm:note

Note

When present, user friendly note to display. Similar to a description, but provides more details about the actual usage of the field.

xdm:note

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

xdm:note Type

object with following properties:

Property Type Required

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: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:sourceVersion

Source Version

Major version being referenced.

xdm:sourceVersion

xdm:sourceVersion Type

number

xdm:title

Title

When present, user friendly title to display.

xdm:title

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

xdm:title Type

object with following properties:

Property Type Required