model.md

April 28, 2025 · View on GitHub

AMF Model Documentation

Table of Contents

APIContractProcessingData

Class that groups data related to how a Base Unit was processed Types:

  • http://a.ml/vocabularies/document#APIContractProcessingData
NameValueSortedDocumentationNamespace
modelVersionstring-Version of the API contract modelhttp://a.ml/vocabularies/apiContract#modelVersion
transformedboolean-Indicates whether a BaseUnit was transformed with some pipelinehttp://a.ml/vocabularies/document#transformed
sourceSpecstring-Standard of the specification filehttp://a.ml/vocabularies/document#sourceSpec

AbstractDeclaration

Graph template that can be used to declare a re-usable graph structure that can be applied to different domain elements in order to re-use common semantics. Similar to a Lisp macro or a C++ template. It can be extended by any domain element adding bindings for the variables in the declaration. Types:

  • http://a.ml/vocabularies/document#AbstractDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
dataNodeDataNode-Associated dynamic structure for the declarationhttp://a.ml/vocabularies/document#dataNode
variable[string]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AbstractOperation

Action that can be executed over the data of a particular shape Types:

  • http://a.ml/vocabularies/core#Operation
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
expects[AbstractRequest]falseRequest information required by the operationhttp://a.ml/vocabularies/core#expects
returns[AbstractResponse]falseResponse data returned by the operationhttp://a.ml/vocabularies/core#returns
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AbstractParameter

Piece of data required or returned by an Operation Types:

  • http://a.ml/vocabularies/core#Parameter
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
paramNamestring-Name of a parameterhttp://a.ml/vocabularies/core#paramName
bindingstring-Part of the Request model where the parameter can be encoded (header, path, query param, etc.)http://a.ml/vocabularies/core#binding
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
requiredboolean-Marks the parameter as requiredhttp://a.ml/vocabularies/core#required
schemaShape-Schema the parameter value must validatehttp://a.ml/vocabularies/shapes#schema
defaultValueDataNode-Default value parsed for a parameterhttp://a.ml/vocabularies/core#defaultValue
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AbstractPayload

Encoded payload using certain media-type Types:

  • http://a.ml/vocabularies/core#Payload
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
schemaShape-Schema associated to this payloadhttp://a.ml/vocabularies/shapes#schema
mediaTypestring-Media types supported in the payloadhttp://a.ml/vocabularies/core#mediaType
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

AbstractRequest

Request information for an operation Types:

  • http://a.ml/vocabularies/core#Request
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
parameter[AbstractParameter]falseParameters associated to the communication modelhttp://a.ml/vocabularies/core#parameter

AbstractResponse

Response information for an operation Types:

  • http://a.ml/vocabularies/core#Response
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
payloadAbstractPayload-Payload for a Request/Responsehttp://a.ml/vocabularies/core#payload

Amqp091ChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
isstring-Defines what type of channel is ithttp://a.ml/vocabularies/apiBinding#is
exchangeAmqp091ChannelExchange-Defines the exchange propertieshttp://a.ml/vocabularies/apiBinding#exchange
queueAmqp091Queue-Defines the queue propertieshttp://a.ml/vocabularies/apiBinding#queue
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091ChannelBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelBinding010
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
isstring-Defines what type of channel is ithttp://a.ml/vocabularies/apiBinding#is
exchangeAmqp091ChannelExchange010-Defines the exchange propertieshttp://a.ml/vocabularies/apiBinding#exchange
queueAmqp091Queue010-Defines the queue propertieshttp://a.ml/vocabularies/apiBinding#queue
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091ChannelBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelBinding020
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
isstring-Defines what type of channel is ithttp://a.ml/vocabularies/apiBinding#is
exchangeAmqp091ChannelExchange020-Defines the exchange propertieshttp://a.ml/vocabularies/apiBinding#exchange
queueAmqp091Queue020-Defines the queue propertieshttp://a.ml/vocabularies/apiBinding#queue
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091ChannelExchange

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelExchange
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
typestring-The type of the exchangehttp://a.ml/vocabularies/apiBinding#type
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091ChannelExchange010

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelExchange010
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
typestring-The type of the exchangehttp://a.ml/vocabularies/apiBinding#type
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091ChannelExchange020

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelExchange020
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
typestring-The type of the exchangehttp://a.ml/vocabularies/apiBinding#type
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
vhoststring-The virtual host of the exchangehttp://a.ml/vocabularies/apiBinding#vhost
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091MessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091MessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
contentEncodingstring-MIME encoding for the message contenthttp://a.ml/vocabularies/apiBinding#contentEncoding
messageTypestring-Application-specific message typehttp://a.ml/vocabularies/apiBinding#messageType
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091OperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091OperationBinding
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
expirationint-TTL (Time-To-Live) for the messagehttp://a.ml/vocabularies/apiBinding#expiration
userIdstring-Identifies the user who has sent the messagehttp://a.ml/vocabularies/apiBinding#userId
cc[string]falseThe routing keys the message should be routed to at the time of publishinghttp://a.ml/vocabularies/apiBinding#cc
priorityint-A priority for the messagehttp://a.ml/vocabularies/apiBinding#priority
deliveryModeint-Delivery mode of the messagehttp://a.ml/vocabularies/apiBinding#deliveryMode
mandatoryboolean-Whether the message is mandatory or nothttp://a.ml/vocabularies/apiBinding#mandatory
bcc[string]falseLike cc but consumers will not receive this informationhttp://a.ml/vocabularies/apiBinding#bcc
timestampboolean-Whether the message should include a timestamp or nothttp://a.ml/vocabularies/apiBinding#timestamp
ackboolean-Whether the consumer should ack the message or nothttp://a.ml/vocabularies/apiBinding#ack
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091OperationBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091OperationBinding010
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
expirationint-TTL (Time-To-Live) for the messagehttp://a.ml/vocabularies/apiBinding#expiration
userIdstring-Identifies the user who has sent the messagehttp://a.ml/vocabularies/apiBinding#userId
cc[string]falseThe routing keys the message should be routed to at the time of publishinghttp://a.ml/vocabularies/apiBinding#cc
priorityint-A priority for the messagehttp://a.ml/vocabularies/apiBinding#priority
deliveryModeint-Delivery mode of the messagehttp://a.ml/vocabularies/apiBinding#deliveryMode
mandatoryboolean-Whether the message is mandatory or nothttp://a.ml/vocabularies/apiBinding#mandatory
bcc[string]falseLike cc but consumers will not receive this informationhttp://a.ml/vocabularies/apiBinding#bcc
replyTostring-Name of the queue where the consumer should send the responsehttp://a.ml/vocabularies/apiBinding#replyTo
timestampboolean-Whether the message should include a timestamp or nothttp://a.ml/vocabularies/apiBinding#timestamp
ackboolean-Whether the consumer should ack the message or nothttp://a.ml/vocabularies/apiBinding#ack
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091OperationBinding030

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091OperationBinding030
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
expirationint-TTL (Time-To-Live) for the messagehttp://a.ml/vocabularies/apiBinding#expiration
userIdstring-Identifies the user who has sent the messagehttp://a.ml/vocabularies/apiBinding#userId
cc[string]falseThe routing keys the message should be routed to at the time of publishinghttp://a.ml/vocabularies/apiBinding#cc
priorityint-A priority for the messagehttp://a.ml/vocabularies/apiBinding#priority
deliveryModeint-Delivery mode of the messagehttp://a.ml/vocabularies/apiBinding#deliveryMode
mandatoryboolean-Whether the message is mandatory or nothttp://a.ml/vocabularies/apiBinding#mandatory
bcc[string]falseLike cc but consumers will not receive this informationhttp://a.ml/vocabularies/apiBinding#bcc
timestampboolean-Whether the message should include a timestamp or nothttp://a.ml/vocabularies/apiBinding#timestamp
ackboolean-Whether the consumer should ack the message or nothttp://a.ml/vocabularies/apiBinding#ack
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091Queue

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelQueue
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
exclusiveboolean-Whether the queue should be used only by one connection or nothttp://a.ml/vocabularies/apiBinding#exclusive
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091Queue010

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelQueue010
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
exclusiveboolean-Whether the queue should be used only by one connection or nothttp://a.ml/vocabularies/apiBinding#exclusive
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Amqp091Queue020

Types:

  • http://a.ml/vocabularies/apiBinding#Amqp091ChannelQueue020
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
durableboolean-Whether the exchange should survive broker restarts or nothttp://a.ml/vocabularies/apiBinding#durable
exclusiveboolean-Whether the queue should be used only by one connection or nothttp://a.ml/vocabularies/apiBinding#exclusive
autoDeleteboolean-Whether the exchange should be deleted when the last queue is unbound from ithttp://a.ml/vocabularies/apiBinding#autoDelete
vhoststring-The virtual host of the exchangehttp://a.ml/vocabularies/apiBinding#vhost
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AnnotationMapping

Types:

  • http://a.ml/vocabularies/meta#NodeAnnotationMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
pathurl-URI for the mapped graph property derived from this mappinghttp://www.w3.org/ns/shacl#path
namestring-Name of the node mappable elementhttp://a.ml/vocabularies/core#name
datatypeurl-Scalar constraint over the type of the mapped graph propertyhttp://www.w3.org/ns/shacl#datatype
node[url]trueObject constraint over the type of the mapped graph propertyhttp://www.w3.org/ns/shacl#node
minCountint-Minimum count constraint over the mapped propertyhttp://www.w3.org/ns/shacl#minCount
patternstring-Pattern constraint over the mapped propertyhttp://www.w3.org/ns/shacl#pattern
minInclusivedouble-Minimum inclusive constraint over the mapped propertyhttp://www.w3.org/ns/shacl#minInclusive
maxInclusivedouble-Maximum inclusive constraint over the mapped propertyhttp://www.w3.org/ns/shacl#maxInclusive
allowMultipleboolean-Allows multiple mapped nodes for the property mappinghttp://a.ml/vocabularies/meta#allowMultiple
sortedboolean-Marks the mapping as requiring order in the mapped collection of nodeshttp://a.ml/vocabularies/meta#sorted
in[Any]trueEnum constraint for the values of the property mappinghttp://www.w3.org/ns/shacl#in
typeDiscriminatorMapstring-Information about the discriminator values in the source AST for the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorMap
uniqueboolean-Marks the values for the property mapping as a primary key for this type of nodehttp://a.ml/vocabularies/meta#unique
externallyLinkableboolean-Marks this object property as supporting external linkshttp://a.ml/vocabularies/meta#externallyLinkable
typeDiscriminatorNamestring-Information about the field in the source AST to be used as discrimintaro in the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorName
mapPropertystring-Marks the mapping as a 'map' mapping syntax. Directly related with mapTermKeyPropertyhttp://a.ml/vocabularies/meta#mapProperty
mapValuePropertystring-Marks the mapping as a 'map value' mapping syntax. Directly related with mapTermValuePropertyhttp://a.ml/vocabularies/meta#mapValueProperty
mapTermPropertyurl-Marks the mapping as a 'map' mapping syntax.http://a.ml/vocabularies/meta#mapTermProperty
mapTermValuePropertyurl-Marks the mapping as a 'map value' mapping syntaxhttp://a.ml/vocabularies/meta#mapTermValueProperty
domain[url]falseDomain node type IRI for which a specific annotation mapping can be applied. Similar rdfs:domain but at an instance level, rather than schema level.http://a.ml/vocabularies/amf/aml#domain
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AnnotationTypeDeclarationFragment

Fragment encoding a RAML annotation type Types:

  • http://a.ml/vocabularies/apiContract#AnnotationTypeDeclarationFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

AnyMapping

Base class for all mappings stored in the AML graph model Types:

  • http://a.ml/vocabularies/meta#AnyMapping
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
and[url]falseLogical and composition of datahttp://a.ml/vocabularies/amf/aml#and
or[url]falseLogical or composition of datahttp://a.ml/vocabularies/amf/aml#or
components[url]falseArray of component mappings in case of component combination generated mappinghttp://a.ml/vocabularies/amf/aml#components
ifurl-Conditional constraint if over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#if
thenurl-Conditional constraint then over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#then
elseurl-Conditional constraint else over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#else

AnyShape

Base class for all shapes stored in the graph model Types:

  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location

AnypointMQChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#AnypointMQChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationstring-The destination (queue or exchange) name for this channel.http://a.ml/vocabularies/apiBinding#destination
destinationTypestring-The type of destination (either exchange or queue or fifo-queue).http://a.ml/vocabularies/apiBinding#destinationType
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AnypointMQMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#AnypointMQMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
headersShape-A Schema object containing the definitions for HTTP-specific headershttp://a.ml/vocabularies/apiBinding#headers
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ApiKeySettings

Settings for an API Key security scheme Types:

  • http://a.ml/vocabularies/security#ApiKeySettings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-http://a.ml/vocabularies/core#name
instring-http://a.ml/vocabularies/security#in
scope[Scope]falsehttp://a.ml/vocabularies/security#scope
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ArrayNode

Node that represents a dynamic array data structure Types:

  • http://a.ml/vocabularies/data#Array
  • http://www.w3.org/1999/02/22-rdf-syntax-ns#Seq
  • http://a.ml/vocabularies/data#Node
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
member[DataNode]falsehttp://www.w3.org/2000/01/rdf-schema#member
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ArrayShape

Shape that contains a nested collection of data shapes Types:

  • http://a.ml/vocabularies/shapes#ArrayShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
itemsShape-Shapes inside the data arrangementhttp://a.ml/vocabularies/shapes#items
containsShape-One of the shapes in the data arrangementhttp://a.ml/vocabularies/shapes#contains
minCountint-Minimum items count constrainthttp://www.w3.org/ns/shacl#minCount
maxCountint-Maximum items count constrainthttp://www.w3.org/ns/shacl#maxCount
uniqueItemsboolean-Unique items constrainthttp://a.ml/vocabularies/shapes#uniqueItems
collectionFormatstring-Input collection format informationhttp://a.ml/vocabularies/shapes#collectionFormat
unevaluatedItemsboolean-Accepts that items may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedItems
unevaluatedItemsSchemaShape-Items that may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedItemsSchema
qualifiedMinCountint-Minimum number of value nodes constrainthttp://www.w3.org/ns/shacl#qualifiedMinCount
qualifiedMaxCountint-Maximum number of value nodes constrainthttp://www.w3.org/ns/shacl#qualifiedMaxCount
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AsyncApi

Top level element describing a asynchronous API Types:

  • http://a.ml/vocabularies/apiContract#AsyncAPI
  • http://a.ml/vocabularies/apiContract#API
  • http://a.ml/vocabularies/document#RootDomainElement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
identifierstring-The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc.http://a.ml/vocabularies/core#identifier
server[Server]falseServer informationhttp://a.ml/vocabularies/apiContract#server
accepts[string]falseMedia-types accepted in a API requesthttp://a.ml/vocabularies/apiContract#accepts
contentType[string]falseMedia types returned by a API responsehttp://a.ml/vocabularies/apiContract#contentType
scheme[string]falseURI scheme for the API protocolhttp://a.ml/vocabularies/apiContract#scheme
versionstring-Version of the APIhttp://a.ml/vocabularies/core#version
termsOfServicestring-Terms and conditions when using the APIhttp://a.ml/vocabularies/core#termsOfService
providerOrganization-Organization providing some kind of asset or servicehttp://a.ml/vocabularies/core#provider
licenseLicense-License for the APIhttp://a.ml/vocabularies/core#license
documentation[CreativeWork]falseDocumentation associated to the APIhttp://a.ml/vocabularies/core#documentation
endpoint[EndPoint]falseEnd points defined in the APIhttp://a.ml/vocabularies/apiContract#endpoint
webhooks[EndPoint]falseWebhooks defined in the APIhttp://a.ml/vocabularies/apiContract#webhooks
security[SecurityRequirement]falseTextual indication of the kind of security scheme usedhttp://a.ml/vocabularies/security#security
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
defaultSchemastring-The default value for the $schema keyword within Schema Objectshttp://a.ml/vocabularies/apiContract#defaultSchema
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

AvroSchemaDocument

A Document that represents an AVRO Schema Fragment Types:

  • http://a.ml/vocabularies/document#AvroSchemaDocumentModel
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

BaseApi

Top level element describing any kind of API Types:

  • http://a.ml/vocabularies/apiContract#API
  • http://a.ml/vocabularies/document#RootDomainElement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
identifierstring-The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc.http://a.ml/vocabularies/core#identifier
server[Server]falseServer informationhttp://a.ml/vocabularies/apiContract#server
accepts[string]falseMedia-types accepted in a API requesthttp://a.ml/vocabularies/apiContract#accepts
contentType[string]falseMedia types returned by a API responsehttp://a.ml/vocabularies/apiContract#contentType
scheme[string]falseURI scheme for the API protocolhttp://a.ml/vocabularies/apiContract#scheme
versionstring-Version of the APIhttp://a.ml/vocabularies/core#version
termsOfServicestring-Terms and conditions when using the APIhttp://a.ml/vocabularies/core#termsOfService
providerOrganization-Organization providing some kind of asset or servicehttp://a.ml/vocabularies/core#provider
licenseLicense-License for the APIhttp://a.ml/vocabularies/core#license
documentation[CreativeWork]falseDocumentation associated to the APIhttp://a.ml/vocabularies/core#documentation
endpoint[EndPoint]falseEnd points defined in the APIhttp://a.ml/vocabularies/apiContract#endpoint
webhooks[EndPoint]falseWebhooks defined in the APIhttp://a.ml/vocabularies/apiContract#webhooks
security[SecurityRequirement]falseTextual indication of the kind of security scheme usedhttp://a.ml/vocabularies/security#security
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
defaultSchemastring-The default value for the $schema keyword within Schema Objectshttp://a.ml/vocabularies/apiContract#defaultSchema
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

BaseIRI

Encodes information about the base document IRI for the model element @ids Types:

  • http://a.ml/vocabularies/meta#ContextBaseIri
NameValueSortedDocumentationNamespace
iriurl-Base IRI for all the elements in the modelhttp://a.ml/vocabularies/meta#iri
nulledboolean-Marks the baseIRI as null, preventing generation of absolute IRIs in the modelhttp://a.ml/vocabularies/meta#nulled

BaseUnit

Base class for every single document model unit. After parsing a document the parser generate parsing Units. Units encode the domain elements and can reference other units to re-use descriptions. Types:

  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

BaseUnitProcessingData

Class that groups data related to how a Base Unit was processed Types:

  • http://a.ml/vocabularies/document#BaseUnitProcessingData
NameValueSortedDocumentationNamespace
transformedboolean-Indicates whether a BaseUnit was transformed with some pipelinehttp://a.ml/vocabularies/document#transformed
sourceSpecstring-Standard of the specification filehttp://a.ml/vocabularies/document#sourceSpec

BaseUnitSourceInformation

Class that stores information of the source from which the base unit was parsed Types:

  • http://a.ml/vocabularies/document#BaseUnitSourceInformation
NameValueSortedDocumentationNamespace
rootLocationstring-Root source location of base unithttp://a.ml/vocabularies/document#rootLocation
additionalLocations[LocationInformation]falseAdditional source locations from which certain elements where parsedhttp://a.ml/vocabularies/document#additionalLocations

Callback

Model defining the information for a HTTP callback/ webhook Types:

  • http://a.ml/vocabularies/apiContract#Callback
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
expressionstring-Structural location of the information to fulfill the callbackhttp://a.ml/vocabularies/apiContract#expression
endpointEndPoint-Endpoint targeted by the callbackhttp://a.ml/vocabularies/apiContract#endpoint
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ChannelBindings

Types:

  • http://a.ml/vocabularies/apiBinding#ChannelBindings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
bindings[ChannelBinding]falseList of channel bindingshttp://a.ml/vocabularies/apiBinding#bindings
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ClassTerm

Types:

  • http://www.w3.org/2002/07/owl#Class
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the ClassTermhttp://a.ml/vocabularies/core#name
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
descriptionstring-Human readable description for the termhttp://a.ml/vocabularies/core#description
properties[url]falseProperties that have the ClassTerm in the domainhttp://a.ml/vocabularies/meta#properties
subClassOf[url]falseSubsumption relationship across termshttp://www.w3.org/2000/01/rdf-schema#subClassOf
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ComponentModule

Model defining a Component Module Types:

  • http://a.ml/vocabularies/apiContract#ComponentModule
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
versionstring-Version of the APIhttp://a.ml/vocabularies/core#version

ContextMapping

Stores information about mapping rules for a property in the model Types:

  • http://a.ml/vocabularies/meta#ContextMapping
NameValueSortedDocumentationNamespace
contextAliasstring-lexical value of the alias in the contexthttp://a.ml/vocabularies/meta#contextAlias
iriurl-Base IRI for all the elements in the modelhttp://a.ml/vocabularies/meta#iri
coercionstring-Type to coerce the mapped modelhttp://a.ml/vocabularies/meta#coercion
nulledboolean-Marks the baseIRI as null, preventing generation of absolute IRIs in the modelhttp://a.ml/vocabularies/meta#nulled
containers[string]falseSets the default containers types for a termhttp://a.ml/vocabularies/meta#containers

CorrelationId

Model defining an identifier that can used for message tracing and correlation Types:

  • http://a.ml/vocabularies/core#CorrelationId
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
locationstring-Structural location of a piece of informationhttp://a.ml/vocabularies/core#location
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

CreativeWork

The most generic kind of creative work, including books, movies, photographs, software programs, etc. Types:

  • http://a.ml/vocabularies/core#CreativeWork
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
urlurl-URL for the creative workhttp://a.ml/vocabularies/core#url
titlestring-Title of the itemhttp://a.ml/vocabularies/core#title
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

CuriePrefix

Stores information about a CURIE prefix defined in the context Types:

  • http://a.ml/vocabularies/meta#ContextCuriePrefix
NameValueSortedDocumentationNamespace
contextAliasstring-lexical value of the alias in the contexthttp://a.ml/vocabularies/meta#contextAlias
iriurl-Base IRI for all the elements in the modelhttp://a.ml/vocabularies/meta#iri

CustomDomainProperty

Definition of an extension to the domain model defined directly by a user in the RAML/OpenAPI document. This can be achieved by using an annotationType in RAML. In OpenAPI thy don't need to be declared, they can just be used. This should be mapped to new RDF properties declared directly in the main document or module. Contrast this extension mechanism with the creation of a propertyTerm in a vocabulary, a more re-usable and generic way of achieving the same functionality. It can be validated using a SHACL shape Types:

  • http://a.ml/vocabularies/document#DomainProperty
  • http://www.w3.org/1999/02/22-rdf-syntax-ns#Property
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
domain[url]falseRDFS domain propertyhttp://www.w3.org/2000/01/rdf-schema#domain
schemaShape-Schema for an entityhttp://a.ml/vocabularies/shapes#schema
namestring-Name for an entityhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
serializationOrderint-position in the set of properties for a shape used to serialize this property on the wirehttp://a.ml/vocabularies/shapes#serializationOrder
repeatableboolean-Indicates if a Domain Element can define more than 1 Domain Extension defined by this Custom Domain Propertyhttp://a.ml/vocabularies/core#repeatable
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DataNode

Base class for all data nodes parsed from the data structure Types:

  • http://a.ml/vocabularies/data#Node
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DataTypeFragment

Fragment encoding a RAML data type Types:

  • http://a.ml/vocabularies/shapes#DataTypeFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DatatypePropertyTerm

Types:

  • http://www.w3.org/2002/07/owl#DatatypeProperty
  • http://a.ml/vocabularies/meta#Property
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
displayNamestring-Human readable name for the property termhttp://a.ml/vocabularies/core#displayName
descriptionstring-Human readable description of the property termhttp://a.ml/vocabularies/core#description
rangeurl-Range of the proeprty term, scalar or objecthttp://www.w3.org/2000/01/rdf-schema#range
subPropertyOf[url]falseSubsumption relationship for termshttp://www.w3.org/2000/01/rdf-schema#subPropertyOf
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DefaultVocabulary

Encodes information about the base vocabulary to map by default properties and types in the model Types:

  • http://a.ml/vocabularies/meta#ContextDefaultVocabulary
NameValueSortedDocumentationNamespace
iriurl-Base IRI for all the elements in the modelhttp://a.ml/vocabularies/meta#iri

Dialect

Definition of an AML dialect, mapping AST nodes from dialect documents into an output semantic graph Types:

  • http://a.ml/vocabularies/meta#Dialect
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
namestring-Name of the dialecthttp://a.ml/vocabularies/core#name
versionstring-Version of the dialecthttp://a.ml/vocabularies/core#version
extensions[SemanticExtension]falseExtensions mappings derived from annotation mappings declarations in a dialecthttp://a.ml/vocabularies/meta#extensions
externals[External]falsehttp://a.ml/vocabularies/meta#externals
documentsDocuments-Document mapping for the the dialecthttp://a.ml/vocabularies/meta#documents
locationstring-Location of the metadata document that generated this base unithttp://a.ml/vocabularies/document#location
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectFragment

AML dialect mapping fragment that can be included in multiple AML dialects Types:

  • http://a.ml/vocabularies/meta#DialectFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
externals[External]falsehttp://a.ml/vocabularies/meta#externals
locationstring-Location of the metadata document that generated this base unithttp://a.ml/vocabularies/document#location
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectInstance

Types:

  • http://a.ml/vocabularies/meta#DialectInstance
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
definedByurl-http://a.ml/vocabularies/meta#definedBy
graphDependencies[url]falsehttp://a.ml/vocabularies/document#graphDependencies
externals[External]falsehttp://a.ml/vocabularies/meta#externals
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectInstanceFragment

Types:

  • http://a.ml/vocabularies/meta#DialectInstanceFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
definedByurl-http://a.ml/vocabularies/meta#definedBy
fragmentstring-http://a.ml/vocabularies/meta#fragment
graphDependencies[url]falsehttp://a.ml/vocabularies/document#graphDependencies
externals[External]falsehttp://a.ml/vocabularies/meta#externals
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectInstanceLibrary

Types:

  • http://a.ml/vocabularies/meta#DialectInstanceLibrary
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
definedByurl-http://a.ml/vocabularies/meta#definedBy
graphDependencies[url]falsehttp://a.ml/vocabularies/document#graphDependencies
externals[External]falsehttp://a.ml/vocabularies/meta#externals
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectInstancePatch

Types:

  • http://a.ml/vocabularies/meta#DialectInstancePatch
  • http://a.ml/vocabularies/document#DocumentExtension
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
definedByurl-http://a.ml/vocabularies/meta#definedBy
graphDependencies[url]falsehttp://a.ml/vocabularies/document#graphDependencies
externals[External]falsehttp://a.ml/vocabularies/meta#externals
extendsurl-Target base unit being extended by this extension modelhttp://a.ml/vocabularies/document#extends
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DialectInstanceProcessingData

Class that groups data related to how a Base Unit was processed Types:

  • http://a.ml/vocabularies/document#DialectInstanceProcessingData
NameValueSortedDocumentationNamespace
definedByurl-Dialect used to parse this Dialect Instancehttp://a.ml/vocabularies/meta#definedBy
graphDependencies[url]falseOther dialects referenced to parse specific nodes in this Dialect Instancehttp://a.ml/vocabularies/document#graphDependencies
transformedboolean-Indicates whether a BaseUnit was transformed with some pipelinehttp://a.ml/vocabularies/document#transformed
sourceSpecstring-Standard of the specification filehttp://a.ml/vocabularies/document#sourceSpec

DialectLibrary

Library of AML mappings that can be reused in different AML dialects Types:

  • http://a.ml/vocabularies/meta#DialectLibrary
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
externals[External]falsehttp://a.ml/vocabularies/meta#externals
locationstring-Location of the metadata document that generated this base unithttp://a.ml/vocabularies/document#location
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DiscriminatorValueMapping

Mapping that relates a certain discriminator value to a certain shape Types:

  • http://a.ml/vocabularies/shapes#DiscriminatorValueMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
discriminatorValuestring-Value given to a discriminator that identifies a target Shapehttp://a.ml/vocabularies/shapes#discriminatorValue
discriminatorValueTargetShape-Target shape for a certain discriminator valuehttp://a.ml/vocabularies/shapes#discriminatorValueTarget
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Document

A Document is a parsing Unit that encodes a stand-alone DomainElement and can include references to other DomainElements that reference from the encoded DomainElement. Since it encodes a DomainElement, but also declares references, it behaves like a Fragment and a Module at the same time. The main difference is that the Document encoded DomainElement is stand-alone and that the references declared are supposed to be private not for re-use from other Units Types:

  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

DocumentMapping

Mapping for a particular dialect document into a graph base unit Types:

  • http://a.ml/vocabularies/meta#DocumentMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the document for a dialect base unithttp://a.ml/vocabularies/core#name
encodedNodeurl-Node in the dialect encoded in the target mapped base unithttp://a.ml/vocabularies/meta#encodedNode
declaredNode[PublicNodeMapping]falseNode in the dialect declared in the target mappend base unithttp://a.ml/vocabularies/meta#declaredNode
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DocumentationItemFragment

Fragment encoding a RAML documentation item Types:

  • http://a.ml/vocabularies/apiContract#UserDocumentationFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

Documents

Mapping from different type of dialect documents to base units in the parsed graph Types:

  • http://a.ml/vocabularies/meta#DocumentsModel
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
rootDocumentDocumentMapping-Root node encoded in a mapped document base unithttp://a.ml/vocabularies/meta#rootDocument
fragments[DocumentMapping]falseMapping of fragment base unit for a particular dialecthttp://a.ml/vocabularies/meta#fragments
libraryDocumentMapping-Mappig of module base unit for a particular dialecthttp://a.ml/vocabularies/meta#library
selfEncodedboolean-Information about if the base unit URL should be the same as the URI of the parsed root nodes in the unithttp://a.ml/vocabularies/meta#selfEncoded
declarationsPathstring-Information about the AST location of the declarations to be parsed as declared domain elementshttp://a.ml/vocabularies/meta#declarationsPath
keyPropertyboolean-Information about whether the dialect is defined by the header or a key propertyhttp://a.ml/vocabularies/meta#keyProperty
referenceStylestring-Determines the style for inclusions (RamlStyle or JsonSchemaStyle)http://a.ml/vocabularies/meta#referenceStyle
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DomainElement

Base class for any element describing a domain model. Domain Elements are encoded or declared into base units Types:

  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

DomainExtension

Extension to the model being parsed from RAML annotation or OpenAPI extensions They must be a DomainPropertySchema (only in RAML) defining them. The DomainPropertySchema might have an associated Data Shape that must validate the extension nested graph. They are parsed as RDF graphs using a default transformation from a set of nested records into RDF. Types:

  • http://a.ml/vocabularies/apiContract#DomainExtension
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
extensionNamestring-Name of an extension entityhttp://a.ml/vocabularies/core#extensionName
definedByCustomDomainProperty-Definition for the extended entityhttp://a.ml/vocabularies/document#definedBy
extensionDataNode-Data structure associated to the extensionhttp://a.ml/vocabularies/document#extension
elementstring-Element being extendedhttp://a.ml/vocabularies/document#element
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

EmptyBinding

Types:

  • http://a.ml/vocabularies/apiBinding#EmptyBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type

Encoding

Types:

  • http://a.ml/vocabularies/apiContract#Encoding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
propertyNamestring-http://a.ml/vocabularies/apiContract#propertyName
contentTypestring-http://a.ml/vocabularies/apiContract#contentType
header[Parameter]falsehttp://a.ml/vocabularies/apiContract#header
stylestring-Describes how a specific property value will be serialized depending on its type.http://a.ml/vocabularies/apiContract#style
explodeboolean-http://a.ml/vocabularies/apiContract#explode
allowReservedboolean-http://a.ml/vocabularies/apiContract#allowReserved
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

EndPoint

EndPoint in the API holding a number of executable operations Types:

  • http://a.ml/vocabularies/apiContract#EndPoint
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
pathstring-Path template for an endpointhttp://a.ml/vocabularies/apiContract#path
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
summarystring-Human readable short description of the endpointhttp://a.ml/vocabularies/core#summary
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
supportedOperation[Operation]falseOperations supported by an endpointhttp://a.ml/vocabularies/apiContract#supportedOperation
parameter[Parameter]falseAdditional data required or returned by an operationhttp://a.ml/vocabularies/apiContract#parameter
payload[Payload]falseMain payload data required or returned by an operationhttp://a.ml/vocabularies/apiContract#payload
server[Server]falseSpecific information about the server where the endpoint is accessiblehttp://a.ml/vocabularies/apiContract#server
security[SecurityRequirement]falseTextual indication of the kind of security scheme usedhttp://a.ml/vocabularies/security#security
bindingChannelBindings-Bindings for this endpointhttp://a.ml/vocabularies/apiBinding#binding
federationMetadataEndpointFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

EndpointFederationMetadata

Model that contains data about how the Shape should be federated Types:

  • http://a.ml/vocabularies/federation#EndpointFederationMetadata
  • http://a.ml/vocabularies/federation#FederationMetadata
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name element in the federated graphhttp://a.ml/vocabularies/federation#name
tags[string]falseFederation tags of the elementhttp://a.ml/vocabularies/federation#tags
shareableboolean-Element can be defined by more than one component of the federated graphhttp://a.ml/vocabularies/federation#shareable
inaccessibleboolean-Element cannot be accessed by the federated graphhttp://a.ml/vocabularies/federation#inaccessible
overrideFromstring-Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argumenthttp://a.ml/vocabularies/federation#overrideFrom
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Example

Example value for a schema inside an API Types:

  • http://a.ml/vocabularies/apiContract#Example
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
guiSummarystring-Human readable description of the examplehttp://a.ml/vocabularies/apiContract#guiSummary
descriptionstring-http://a.ml/vocabularies/core#description
externalValuestring-Raw text containing an unparsable examplehttp://a.ml/vocabularies/document#externalValue
strictboolean-Indicates if this example should be validated against an associated schemahttp://a.ml/vocabularies/document#strict
mediaTypestring-Media type associated to the examplehttp://a.ml/vocabularies/core#mediaType
structuredValueDataNode-Data structure containing the value of the examplehttp://a.ml/vocabularies/document#structuredValue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location

Extension

API spec information designed to be applied and compelement the information of a base specification. RAML extensions and overlays are examples of extensions. Types:

  • http://a.ml/vocabularies/apiContract#Extension
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
extendsurl-Target base unit being extended by this extension modelhttp://a.ml/vocabularies/document#extends
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

ExtensionLike

A Document that extends a target document, overwriting part of the information or overlaying additional information. Types:

  • http://a.ml/vocabularies/document#DocumentExtension
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
extendsurl-Target base unit being extended by this extension modelhttp://a.ml/vocabularies/document#extends
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

External

Types:

  • http://www.w3.org/2002/07/owl#Ontology
  • http://a.ml/vocabularies/meta#ExternalVocabulary
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
displayNamestring-The display name of the itemhttp://a.ml/vocabularies/core#displayName
basestring-Base URI for the external modelhttp://a.ml/vocabularies/meta#base
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ExternalContextFields

Types:

NameValueSortedDocumentationNamespace
externals[External]falsehttp://a.ml/vocabularies/meta#externals

ExternalDomainElement

Domain element containing foreign information that cannot be included into the model semantics Types:

  • http://a.ml/vocabularies/document#ExternalDomainElement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
mediaTypestring-Media type associated to the encoded fragment informationhttp://a.ml/vocabularies/core#mediaType

ExternalFragment

Fragment encoding an external entity Types:

  • http://a.ml/vocabularies/document#ExternalFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

ExternalPropertyShape

Model that contains information to locally represent a Property Shape with a Range from an External graph Types:

  • http://a.ml/vocabularies/federation#ExternalPropertyShape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name for an external data shapehttp://www.w3.org/ns/shacl#name
keyMappings[PropertyKeyMapping]falseMapping from local properties to properties from the external range shape (identified by rangeName) to be used for data retrievalhttp://a.ml/vocabularies/federation#keyMappings
rangeNamestring-Federation name of the External Shape in the external graphhttp://a.ml/vocabularies/federation#rangeName
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ExternalSourceElement

Inlined fragment of information Types:

  • http://a.ml/vocabularies/document#ExternalSource
NameValueSortedDocumentationNamespace
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location

FederationMetadata

Model that contains data about how the element should be federated Types:

  • http://a.ml/vocabularies/federation#FederationMetadata
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name element in the federated graphhttp://a.ml/vocabularies/federation#name
tags[string]falseFederation tags of the elementhttp://a.ml/vocabularies/federation#tags
shareableboolean-Element can be defined by more than one component of the federated graphhttp://a.ml/vocabularies/federation#shareable
inaccessibleboolean-Element cannot be accessed by the federated graphhttp://a.ml/vocabularies/federation#inaccessible
overrideFromstring-Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argumenthttp://a.ml/vocabularies/federation#overrideFrom
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

FileShape

Shape describing data uploaded in an API request Types:

  • http://a.ml/vocabularies/shapes#FileShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
fileType[string]falseType of file described by this shapehttp://a.ml/vocabularies/shapes#fileType
patternstring-Pattern constrainthttp://www.w3.org/ns/shacl#pattern
minLengthint-Minimum lenght constrainthttp://www.w3.org/ns/shacl#minLength
maxLengthint-Maximum length constrainthttp://www.w3.org/ns/shacl#maxLength
minInclusivedouble-Minimum inclusive constrainthttp://www.w3.org/ns/shacl#minInclusive
maxInclusivedouble-Maximum inclusive constrainthttp://www.w3.org/ns/shacl#maxInclusive
minExclusiveboolean-Minimum exclusive constrainthttp://www.w3.org/ns/shacl#minExclusive
maxExclusiveboolean-Maximum exclusive constrainthttp://www.w3.org/ns/shacl#maxExclusive
exclusiveMinimumNumericdouble-Minimum exclusive constrainthttp://a.ml/vocabularies/shapes#exclusiveMinimumNumeric
exclusiveMaximumNumericdouble-Maximum exclusive constrainthttp://a.ml/vocabularies/shapes#exclusiveMaximumNumeric
formatstring-Format constrainthttp://a.ml/vocabularies/shapes#format
multipleOfdouble-Multiple of constrainthttp://a.ml/vocabularies/shapes#multipleOf
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Fragment

A Fragment is a parsing Unit that encodes a DomainElement Types:

  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

GooglePubSubChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
labelsObjectNode-An object of key-value pairshttp://a.ml/vocabularies/apiBinding#labels
messageRetentionDurationstring-Indicates the minimum duration to retain a message after it is published to the topichttp://a.ml/vocabularies/apiBinding#messageRetentionDuration
messageStoragePolicyGooglePubSubMessageStoragePolicy-Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be storedhttp://a.ml/vocabularies/apiBinding#messageStoragePolicy
schemaSettingsGooglePubSubSchemaSettings-Settings for validating messages published against a schemahttp://a.ml/vocabularies/apiBinding#schemaSettings
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubChannelBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubChannelBinding010
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicstring-The Google Cloud Pub/Sub Topic namehttp://a.ml/vocabularies/apiBinding#topic
labelsObjectNode-An object of key-value pairshttp://a.ml/vocabularies/apiBinding#labels
messageRetentionDurationstring-Indicates the minimum duration to retain a message after it is published to the topichttp://a.ml/vocabularies/apiBinding#messageRetentionDuration
messageStoragePolicyGooglePubSubMessageStoragePolicy-Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be storedhttp://a.ml/vocabularies/apiBinding#messageStoragePolicy
schemaSettingsGooglePubSubSchemaSettings-Settings for validating messages published against a schemahttp://a.ml/vocabularies/apiBinding#schemaSettings
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubChannelBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubChannelBinding020
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
labelsObjectNode-An object of key-value pairshttp://a.ml/vocabularies/apiBinding#labels
messageRetentionDurationstring-Indicates the minimum duration to retain a message after it is published to the topichttp://a.ml/vocabularies/apiBinding#messageRetentionDuration
messageStoragePolicyGooglePubSubMessageStoragePolicy-Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be storedhttp://a.ml/vocabularies/apiBinding#messageStoragePolicy
schemaSettingsGooglePubSubSchemaSettings-Settings for validating messages published against a schemahttp://a.ml/vocabularies/apiBinding#schemaSettings
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
attributeObjectNode-Attributes for this messagehttp://a.ml/vocabularies/apiBinding#attribute
orderingKeystring-If non-empty, identifies related messages for which publish order should be respectedhttp://a.ml/vocabularies/apiBinding#orderingKey
schemaDefinitionGooglePubSubSchemaDefinition-Define Schemahttp://a.ml/vocabularies/apiBinding#schemaDefinition
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubMessageBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubMessageBinding010
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
attributeObjectNode-Attributes for this messagehttp://a.ml/vocabularies/apiBinding#attribute
orderingKeystring-If non-empty, identifies related messages for which publish order should be respectedhttp://a.ml/vocabularies/apiBinding#orderingKey
schemaDefinitionGooglePubSubSchemaDefinition010-Define Schemahttp://a.ml/vocabularies/apiBinding#schemaDefinition
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubMessageBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubMessageBinding020
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
attributeObjectNode-Attributes for this messagehttp://a.ml/vocabularies/apiBinding#attribute
orderingKeystring-If non-empty, identifies related messages for which publish order should be respectedhttp://a.ml/vocabularies/apiBinding#orderingKey
schemaDefinitionGooglePubSubSchemaDefinition020-Define Schemahttp://a.ml/vocabularies/apiBinding#schemaDefinition
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubMessageStoragePolicy

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubMessageStoragePolicy
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
allowedPersistenceRegions[string]falseA list of IDs of GCP regions where messages that are published to the topic may be persisted in storagehttp://a.ml/vocabularies/apiBinding#allowedPersistenceRegions
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubSchemaDefinition

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubSchemaDefinition
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubSchemaDefinition010

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubSchemaDefinition010
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-The type of the schemahttp://a.ml/vocabularies/apiBinding#type
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubSchemaDefinition020

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubSchemaDefinition020
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

GooglePubSubSchemaSettings

Types:

  • http://a.ml/vocabularies/apiBinding#GooglePubSubSchemaSettings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
encodingstring-The encoding of the messagehttp://a.ml/vocabularies/apiBinding#encoding
firstRevisionIdstring-The minimum (inclusive) revision allowed for validating messageshttp://a.ml/vocabularies/apiBinding#firstRevisionId
lastRevisionIdstring-The maximum (inclusive) revision allowed for validating messageshttp://a.ml/vocabularies/apiBinding#lastRevisionId
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpApiKeySettings

Settings for an Http API Key security scheme Types:

  • http://a.ml/vocabularies/security#HttpApiKeySettings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-http://a.ml/vocabularies/core#name
instring-http://a.ml/vocabularies/security#in
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#HttpMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
headersShape-A Schema object containing the definitions for HTTP-specific headershttp://a.ml/vocabularies/apiBinding#headers
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpMessageBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#HttpMessageBinding020
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
headersShape-A Schema object containing the definitions for HTTP-specific headershttp://a.ml/vocabularies/apiBinding#headers
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpMessageBinding030

Types:

  • http://a.ml/vocabularies/apiBinding#HttpMessageBinding030
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
statusCodeint-The HTTP response status code according to RFC 9110.http://a.ml/vocabularies/apiBinding#statusCode
headersShape-A Schema object containing the definitions for HTTP-specific headershttp://a.ml/vocabularies/apiBinding#headers
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpOperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#HttpOperationBinding
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
methodstring-Operation binding methodhttp://a.ml/vocabularies/apiBinding#method
queryShape-A Schema object containing the definitions for each query parameterhttp://a.ml/vocabularies/apiBinding#query
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpOperationBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#HttpOperationBinding010
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
operationTypestring-Type of operationhttp://a.ml/vocabularies/apiBinding#operationType
methodstring-Operation binding methodhttp://a.ml/vocabularies/apiBinding#method
queryShape-A Schema object containing the definitions for each query parameterhttp://a.ml/vocabularies/apiBinding#query
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpOperationBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#HttpOperationBinding020
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
methodstring-Operation binding methodhttp://a.ml/vocabularies/apiBinding#method
queryShape-A Schema object containing the definitions for each query parameterhttp://a.ml/vocabularies/apiBinding#query
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

HttpSettings

Settings for an HTTP security scheme Types:

  • http://a.ml/vocabularies/security#HttpSettings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
schemestring-http://a.ml/vocabularies/security#scheme
bearerFormatstring-http://a.ml/vocabularies/security#bearerFormat
scope[Scope]falsehttp://a.ml/vocabularies/security#scope
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IBMMQChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#IBMMQChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-Defines the type of AsyncAPI channel.http://a.ml/vocabularies/apiBinding#destinationType
queueIBMMQChannelQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
topicIBMMQChannelTopic-Defines the properties of a topic.http://a.ml/vocabularies/apiBinding#topic
maxMsgLengthint-The maximum length of the physical message (in bytes) accepted by the Topic or Queue. Messages produced that are greater in size than this value may fail to be delivered.http://a.ml/vocabularies/apiBinding#maxMsgLength
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IBMMQChannelQueue

Types:

  • http://a.ml/vocabularies/apiBinding#IBMMQChannelQueue
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
objectNamestring-Defines the name of the IBM MQ queue associated with the channel.http://a.ml/vocabularies/apiBinding#objectName
isPartitionedboolean-Defines if the queue is a cluster queue and therefore partitioned. If true, a binding option MAY be specified when accessing the queue.http://a.ml/vocabularies/apiBinding#isPartitioned
exclusiveboolean-Specifies if it is recommended to open the queue exclusively.http://a.ml/vocabularies/apiBinding#exclusive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IBMMQChannelTopic

Types:

  • http://a.ml/vocabularies/apiBinding#IBMMQChannelTopic
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
stringstring-The value of the IBM MQ topic string to be used.http://a.ml/vocabularies/apiBinding#string
objectNamestring-The name of the IBM MQ topic object.http://a.ml/vocabularies/apiBinding#objectName
durablePermittedboolean-Defines if the subscription may be durable.http://a.ml/vocabularies/apiBinding#durablePermitted
lastMsgRetainedboolean-Defines if the last message published will be made available to new subscriptions.http://a.ml/vocabularies/apiBinding#lastMsgRetained
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IBMMQMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#IBMMQMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
messageTypestring-The type of the messagehttp://a.ml/vocabularies/apiBinding#messageType
headers[string]falseDefines the IBM MQ message headers to include with this message. More than one header can be specified as a comma separated list.http://a.ml/vocabularies/apiBinding#headers
descriptionstring-http://a.ml/vocabularies/core#description
expiryint-This is a period of time expressed in milliseconds and set by the application that puts the message.http://a.ml/vocabularies/apiBinding#expiry
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IBMMQServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#IBMMQServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
groupIdstring-Defines a logical group of IBM MQ server objects. This is necessary to specify multi-endpoint configurations used in high availability deployments. If omitted, the server object is not part of a group.http://a.ml/vocabularies/apiBinding#groupId
ccdtQueueManagerNamestring-The name of the IBM MQ queue manager to bind to in the CCDT file.http://a.ml/vocabularies/apiBinding#ccdtQueueManagerName
cipherSpecstring-The recommended cipher specification used to establish a TLS connection between the client and the IBM MQ queue manager.http://a.ml/vocabularies/apiBinding#cipherSpec
multiEndpointServerboolean-If multiEndpointServer is true then multiple connections can be workload balanced and applications should not make assumptions as to where messages are processed. Where message ordering, or affinity to specific message resources is necessary, a single endpoint (multiEndpointServer = false) may be required.http://a.ml/vocabularies/apiBinding#multiEndpointServer
heartBeatIntervalint-The recommended value (in seconds) for the heartbeat sent to the queue manager during periods of inactivity. A value of zero means that no heart beats are sent. A value of 1 means that the client will use the value defined by the queue manager.http://a.ml/vocabularies/apiBinding#heartBeatInterval
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

IriTemplateMapping

Types:

  • http://a.ml/vocabularies/apiContract#IriTemplateMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
templateVariablestring-Variable defined inside an URL templatehttp://a.ml/vocabularies/apiContract#templateVariable
linkExpressionstring-OAS 3 link expressionhttp://a.ml/vocabularies/apiContract#linkExpression
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

JsonLDElement

Base class for all the JSON-LD elements Types:

  • http://a.ml/vocabularies/document#JsonLDElement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace

JsonLDInstanceDocument

A Document that represents a JSON-LD instance document Types:

  • http://a.ml/vocabularies/document#JsonLDInstanceDocument
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodes[JsonLDElement]falseThe encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

JsonSchemaDocument

A Document that represents a JSON Schema Fragment Types:

  • http://a.ml/vocabularies/document#JsonSchemaDocument
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
schemaVersionstring-JSON Schema version of the documenthttp://a.ml/vocabularies/document#schemaVersion
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

KafkaChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicstring-Kafka topic name if different from channel name.http://a.ml/vocabularies/apiBinding#topic
partitionsint-Number of partitions configured on this topic.http://a.ml/vocabularies/apiBinding#partitions
replicasint-Number of replicas configured on this topic.http://a.ml/vocabularies/apiBinding#replicas
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaChannelBinding030

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaChannelBinding030
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicstring-Kafka topic name if different from channel name.http://a.ml/vocabularies/apiBinding#topic
partitionsint-Number of partitions configured on this topic.http://a.ml/vocabularies/apiBinding#partitions
replicasint-Number of replicas configured on this topic.http://a.ml/vocabularies/apiBinding#replicas
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaChannelBinding040

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaChannelBinding040
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicConfiguration040KafkaTopicConfiguration040-Topic configuration properties that are relevant for the API.http://a.ml/vocabularies/apiBinding#topicConfiguration040
topicstring-Kafka topic name if different from channel name.http://a.ml/vocabularies/apiBinding#topic
partitionsint-Number of partitions configured on this topic.http://a.ml/vocabularies/apiBinding#partitions
replicasint-Number of replicas configured on this topic.http://a.ml/vocabularies/apiBinding#replicas
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaChannelBinding050

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaChannelBinding050
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicConfiguration050KafkaTopicConfiguration050-Topic configuration properties that are relevant for the API.http://a.ml/vocabularies/apiBinding#topicConfiguration050
topicstring-Kafka topic name if different from channel name.http://a.ml/vocabularies/apiBinding#topic
partitionsint-Number of partitions configured on this topic.http://a.ml/vocabularies/apiBinding#partitions
replicasint-Number of replicas configured on this topic.http://a.ml/vocabularies/apiBinding#replicas
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
messageKeyShape-Schema that defines the message keyhttp://a.ml/vocabularies/apiBinding#messageKey
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaMessageBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaMessageBinding010
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
messageKeyShape-Schema that defines the message keyhttp://a.ml/vocabularies/apiBinding#messageKey
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaMessageBinding030

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaMessageBinding030
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
schemaIdLocationstring-If a Schema Registry is used when performing this operation, tells where the id of schema is stored (e.g. header or payload).http://a.ml/vocabularies/apiBinding#schemaIdLocation
schemaIdPayloadEncodingstring-Number of bytes or vendor specific values when schema id is encoded in payload (e.g confluent/ apicurio-legacy / apicurio-new).http://a.ml/vocabularies/apiBinding#schemaIdPayloadEncoding
schemaLookupStrategystring-Freeform string for any naming strategy class to use. Clients should default to the vendor default if not supplied.http://a.ml/vocabularies/apiBinding#schemaLookupStrategy
messageKeyShape-Schema that defines the message keyhttp://a.ml/vocabularies/apiBinding#messageKey
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaOperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaOperationBinding
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
groupIdShape-Schema that defines the id of the consumer grouphttp://a.ml/vocabularies/apiBinding#groupId
clientIdShape-Schema that defines the id of the consumer inside a consumer grouphttp://a.ml/vocabularies/apiBinding#clientId
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
schemaRegistryUrlstring-API URL for the Schema Registry used when producing Kafka messages (if a Schema Registry was used)http://a.ml/vocabularies/apiBinding#schemaRegistryUrl
schemaRegistryVendorstring-The vendor of Schema Registry and Kafka serdes library that should be usedhttp://a.ml/vocabularies/apiBinding#schemaRegistryVendor
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

KafkaTopicConfiguration

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaTopicConfiguration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
CleanupPolicy[string]falseThe cleanup.policy configuration option.http://a.ml/vocabularies/apiBinding#CleanupPolicy
RetentionMsint-The retention.ms configuration option.http://a.ml/vocabularies/apiBinding#RetentionMs
RetentionBytesint-The retention.bytes configuration option.http://a.ml/vocabularies/apiBinding#RetentionBytes
DeleteRetentionMsint-The delete.retention.ms configuration option.http://a.ml/vocabularies/apiBinding#DeleteRetentionMs
MaxMessageBytesint-The max.message.bytes configuration option.http://a.ml/vocabularies/apiBinding#MaxMessageBytes

KafkaTopicConfiguration040

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaTopicConfiguration040
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
CleanupPolicy[string]falseThe cleanup.policy configuration option.http://a.ml/vocabularies/apiBinding#CleanupPolicy
RetentionMsint-The retention.ms configuration option.http://a.ml/vocabularies/apiBinding#RetentionMs
RetentionBytesint-The retention.bytes configuration option.http://a.ml/vocabularies/apiBinding#RetentionBytes
DeleteRetentionMsint-The delete.retention.ms configuration option.http://a.ml/vocabularies/apiBinding#DeleteRetentionMs
MaxMessageBytesint-The max.message.bytes configuration option.http://a.ml/vocabularies/apiBinding#MaxMessageBytes

KafkaTopicConfiguration050

Types:

  • http://a.ml/vocabularies/apiBinding#KafkaTopicConfiguration050
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
ConfluentKeySchemaValidationboolean-It shows whether the schema validation for the message key is enabled. Vendor specific config.http://a.ml/vocabularies/apiBinding#ConfluentKeySchemaValidation
ConfluentKeySubjectNameStrategystring-The name of the schema lookup strategy for the message key. Vendor specific config.http://a.ml/vocabularies/apiBinding#ConfluentKeySubjectNameStrategy
ConfluentValueSchemaValidationboolean-It shows whether the schema validation for the message value is enabled. Vendor specific config.http://a.ml/vocabularies/apiBinding#ConfluentValueSchemaValidation
ConfluentValueSubjectNameStrategystring-The name of the schema lookup strategy for the message value. Vendor specific config.http://a.ml/vocabularies/apiBinding#ConfluentValueSubjectNameStrategy
CleanupPolicy[string]falseThe cleanup.policy configuration option.http://a.ml/vocabularies/apiBinding#CleanupPolicy
RetentionMsint-The retention.ms configuration option.http://a.ml/vocabularies/apiBinding#RetentionMs
RetentionBytesint-The retention.bytes configuration option.http://a.ml/vocabularies/apiBinding#RetentionBytes
DeleteRetentionMsint-The delete.retention.ms configuration option.http://a.ml/vocabularies/apiBinding#DeleteRetentionMs
MaxMessageBytesint-The max.message.bytes configuration option.http://a.ml/vocabularies/apiBinding#MaxMessageBytes

Key

Model that represents the Key of an element to be retrieved by the federated graph Types:

  • http://a.ml/vocabularies/federation#Key
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
keyComponents[PropertyShapePath]falseComponents that make up this Keyhttp://a.ml/vocabularies/federation#keyComponents
isResolvableboolean-http://a.ml/vocabularies/federation#isResolvable
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

License

Licensing information for a resource Types:

  • http://a.ml/vocabularies/core#License
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
urlurl-URL identifying the organizationhttp://a.ml/vocabularies/core#url
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
identifierstring-SPDX license expression for the APIhttp://a.ml/vocabularies/core#identifier
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

LinkNode

Node that represents a dynamic link in a data structure Types:

  • http://a.ml/vocabularies/data#Link
  • http://a.ml/vocabularies/data#Node
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
valuestring-http://a.ml/vocabularies/data#value
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

LinkableElement

Reification of a link between elements in the model. Used when we want to capture the structure of the source document in the graph itself. Linkable elements are just replaced by regular links after resolution. Types:

  • http://a.ml/vocabularies/document#Linkable
NameValueSortedDocumentationNamespace
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

LocationInformation

Class that store a specific location and the elements that where parsed from this source Types:

  • http://a.ml/vocabularies/document#LocationInformation
NameValueSortedDocumentationNamespace
locationstring-Location of the metadata document that generated this base unithttp://a.ml/vocabularies/document#location
elements[url]falseElements which all belong to a certain source locationhttp://a.ml/vocabularies/document#elements

MatrixShape

Data shape containing nested multi-dimensional collection shapes Types:

  • http://a.ml/vocabularies/shapes#MatrixShape
  • http://a.ml/vocabularies/shapes#ArrayShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
itemsShape-Shapes inside the data arrangementhttp://a.ml/vocabularies/shapes#items
containsShape-One of the shapes in the data arrangementhttp://a.ml/vocabularies/shapes#contains
minCountint-Minimum items count constrainthttp://www.w3.org/ns/shacl#minCount
maxCountint-Maximum items count constrainthttp://www.w3.org/ns/shacl#maxCount
uniqueItemsboolean-Unique items constrainthttp://a.ml/vocabularies/shapes#uniqueItems
collectionFormatstring-Input collection format informationhttp://a.ml/vocabularies/shapes#collectionFormat
unevaluatedItemsboolean-Accepts that items may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedItems
unevaluatedItemsSchemaShape-Items that may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedItemsSchema
qualifiedMinCountint-Minimum number of value nodes constrainthttp://www.w3.org/ns/shacl#qualifiedMinCount
qualifiedMaxCountint-Maximum number of value nodes constrainthttp://www.w3.org/ns/shacl#qualifiedMaxCount
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Message

Types:

  • http://a.ml/vocabularies/apiContract#Message
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
payload[Payload]falsePayload for a Request/Responsehttp://a.ml/vocabularies/apiContract#payload
correlationIdCorrelationId-An identifier that can be used for message tracing and correlationhttp://a.ml/vocabularies/core#correlationId
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
titlestring-Title of the itemhttp://a.ml/vocabularies/core#title
summarystring-Human readable short description of the request/responsehttp://a.ml/vocabularies/core#summary
header[Parameter]falseParameter passed as a header to an operation for communication modelshttp://a.ml/vocabularies/apiContract#header
bindingMessageBindings-Bindings for this request/responsehttp://a.ml/vocabularies/apiBinding#binding
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
isAbstractboolean-Defines a model as abstracthttp://a.ml/vocabularies/apiContract#isAbstract
headerExamples[Example]falseExamples for a header definitionhttp://a.ml/vocabularies/apiContract#headerExamples
headerSchemaNodeShape-Object Schema who's properties are headers for the message.http://a.ml/vocabularies/apiContract#headerSchema
messageIdstring-Unique Id for request and response messagehttp://a.ml/vocabularies/apiContract#messageId
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MessageBindings

Types:

  • http://a.ml/vocabularies/apiBinding#MessageBindings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
bindings[MessageBinding]falseList of message bindingshttp://a.ml/vocabularies/apiBinding#bindings
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Module

A Module is a parsing Unit that declares DomainElements that can be referenced from the DomainElements in other parsing Units. It main purpose is to expose the declared references so they can be re-used Types:

  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

MqttMessageBinding

Types:

  • http://a.ml/vocabularies/apiBinding#MqttMessageBinding
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttMessageBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#MqttMessageBinding010
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttMessageBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#MqttMessageBinding020
  • http://a.ml/vocabularies/apiBinding#MessageBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
payloadFormatIndicatorint-Either: 0 (zero): Indicates that the payload is unspecified bytes, or 1: Indicates that the payload is UTF-8 encoded character data.http://a.ml/vocabularies/apiBinding#payloadFormatIndicator
correlationDataShape-Correlation Data is used by the sender of the request message to identify which request the response message is for when it is received.http://a.ml/vocabularies/apiBinding#correlationData
contentTypestring-String describing the content type of the message payload. This should not conflict with the contentType field of the associated AsyncAPI Message object.http://a.ml/vocabularies/apiBinding#contentType
responseTopicstring-The topic (channel URI) for a response message.http://a.ml/vocabularies/apiBinding#responseTopic
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttOperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#MqttOperationBinding
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
qosint-Defines how hard the broker/client will try to ensure that a message is receivedhttp://a.ml/vocabularies/apiBinding#qos
retainboolean-Whether the broker should retain the message or nothttp://a.ml/vocabularies/apiBinding#retain
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttOperationBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#MqttOperationBinding010
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
qosint-Defines how hard the broker/client will try to ensure that a message is receivedhttp://a.ml/vocabularies/apiBinding#qos
retainboolean-Whether the broker should retain the message or nothttp://a.ml/vocabularies/apiBinding#retain
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttOperationBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#MqttOperationBinding020
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
messageExpiryIntervalint-Interval in seconds or a Schema Object containing the definition of the lifetime of the message.http://a.ml/vocabularies/apiBinding#messageExpiryInterval
qosint-Defines how hard the broker/client will try to ensure that a message is receivedhttp://a.ml/vocabularies/apiBinding#qos
retainboolean-Whether the broker should retain the message or nothttp://a.ml/vocabularies/apiBinding#retain
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#MqttServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
clientIdstring-The client identifierhttp://a.ml/vocabularies/apiBinding#clientId
cleanSessionboolean-Whether to create a persistent connection or nothttp://a.ml/vocabularies/apiBinding#cleanSession
lastWillMqttServerLastWill-Last Will and Testament configurationhttp://a.ml/vocabularies/apiBinding#lastWill
keepAliveint-Interval in seconds of the longest period of time the broker and the client can endure without sending a messagehttp://a.ml/vocabularies/apiBinding#keepAlive
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttServerBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#MqttServerBinding010
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
clientIdstring-The client identifierhttp://a.ml/vocabularies/apiBinding#clientId
cleanSessionboolean-Whether to create a persistent connection or nothttp://a.ml/vocabularies/apiBinding#cleanSession
lastWillMqttServerLastWill-Last Will and Testament configurationhttp://a.ml/vocabularies/apiBinding#lastWill
keepAliveint-Interval in seconds of the longest period of time the broker and the client can endure without sending a messagehttp://a.ml/vocabularies/apiBinding#keepAlive
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttServerBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#MqttServerBinding020
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
sessionExpiryIntervalint-Interval in seconds or a Schema Object containing the definition of the interval. The broker maintains a session for a disconnected client until this interval expires.http://a.ml/vocabularies/apiBinding#sessionExpiryInterval
sessionExpiryIntervalSchemaShape-Interval in seconds or a Schema Object containing the definition of the interval. The broker maintains a session for a disconnected client until this interval expires.http://a.ml/vocabularies/apiBinding#sessionExpiryIntervalSchema
maximumPacketSizeint-Number of bytes or a Schema Object representing the maximum packet size the client is willing to accept.http://a.ml/vocabularies/apiBinding#maximumPacketSize
maximumPacketSizeSchemaShape-Number of bytes or a Schema Object representing the maximum packet size the client is willing to accept.http://a.ml/vocabularies/apiBinding#maximumPacketSizeSchema
clientIdstring-The client identifierhttp://a.ml/vocabularies/apiBinding#clientId
cleanSessionboolean-Whether to create a persistent connection or nothttp://a.ml/vocabularies/apiBinding#cleanSession
lastWillMqttServerLastWill-Last Will and Testament configurationhttp://a.ml/vocabularies/apiBinding#lastWill
keepAliveint-Interval in seconds of the longest period of time the broker and the client can endure without sending a messagehttp://a.ml/vocabularies/apiBinding#keepAlive
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MqttServerLastWill

Types:

  • http://a.ml/vocabularies/apiBinding#MqttServerLastWill
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicstring-The topic where the Last Will and Testament message will be senthttp://a.ml/vocabularies/apiBinding#topic
qosint-Defines how hard the broker/client will try to ensure that the Last Will and Testament message is receivedhttp://a.ml/vocabularies/apiBinding#qos
retainboolean-Whether the broker should retain the Last Will and Testament message or nothttp://a.ml/vocabularies/apiBinding#retain
messagestring-Message used to notify other clients about an ungracefully disconnected client.http://a.ml/vocabularies/apiBinding#message
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

MutualTLSSettings

Settings for an Mutual TLS security scheme Types:

  • http://a.ml/vocabularies/security#MutualTLSSettings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
scope[Scope]falsehttp://a.ml/vocabularies/security#scope
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

NamedExampleFragment

Fragment encoding a RAML named example Types:

  • http://a.ml/vocabularies/apiContract#NamedExampleFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

NilShape

Data shape representing the null/nil value in the input schema Types:

  • http://a.ml/vocabularies/shapes#NilShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location

NodeMapping

Types:

  • http://a.ml/vocabularies/meta#NodeMapping
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
targetClassurl-Target class whose instances will need to match the constraint described for the nodehttp://www.w3.org/ns/shacl#targetClass
namestring-Name of the node mappable elementhttp://a.ml/vocabularies/core#name
property[PropertyMapping]falseData shape constraint for a property of the target nodehttp://www.w3.org/ns/shacl#property
uriTemplatestring-URI template that will be used to generate the URI of the parsed nodeds in the graphhttp://a.ml/vocabularies/apiContract#uriTemplate
mergePolicystring-Indication of how to merge this graph node when applying a patch documenthttp://a.ml/vocabularies/meta#mergePolicy
resolvedExtends[url]falsehttp://a.ml/vocabularies/meta#resolvedExtends
closedboolean-Additional properties in the input node accepted constrainthttp://www.w3.org/ns/shacl#closed
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
and[url]falseLogical and composition of datahttp://a.ml/vocabularies/amf/aml#and
or[url]falseLogical or composition of datahttp://a.ml/vocabularies/amf/aml#or
components[url]falseArray of component mappings in case of component combination generated mappinghttp://a.ml/vocabularies/amf/aml#components
ifurl-Conditional constraint if over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#if
thenurl-Conditional constraint then over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#then
elseurl-Conditional constraint else over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#else

NodeShape

Shape that validates a record of fields, like a JS object Types:

  • http://www.w3.org/ns/shacl#NodeShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
isAbstractboolean-Marks this shape as an abstract node shape declared for pure re-usehttp://a.ml/vocabularies/shapes#isAbstract
minPropertiesint-Minimum number of properties in the input node constrainthttp://a.ml/vocabularies/shapes#minProperties
maxPropertiesint-Maximum number of properties in the input node constrainthttp://a.ml/vocabularies/shapes#maxProperties
closedboolean-Additional properties in the input node accepted constrainthttp://www.w3.org/ns/shacl#closed
additionalPropertiesKeySchemaShape-Additional properties key schemahttp://www.w3.org/ns/shacl#additionalPropertiesKeySchema
additionalPropertiesSchemaShape-Additional properties schemahttp://www.w3.org/ns/shacl#additionalPropertiesSchema
discriminatorstring-Discriminator propertyhttp://a.ml/vocabularies/shapes#discriminator
discriminatorValuestring-Values for the discriminator propertyhttp://a.ml/vocabularies/shapes#discriminatorValue
discriminatorValueDataNodeDataNode-Value for the discriminator property represented as a DataNodehttp://a.ml/vocabularies/shapes#discriminatorValueDataNode
discriminatorMapping[IriTemplateMapping]falseMapping of acceptable values for the node discriminatorhttp://a.ml/vocabularies/shapes#discriminatorMapping
discriminatorValueMapping[DiscriminatorValueMapping]falseMapping of acceptable values for the node discriminatorhttp://a.ml/vocabularies/shapes#discriminatorValueMapping
property[PropertyShape]falseProperties associated to this nodehttp://www.w3.org/ns/shacl#property
propertyNamesShape-Property names schemahttp://www.w3.org/ns/shacl#propertyNames
dependencies[PropertyDependencies]falseDependent properties constrainthttp://a.ml/vocabularies/shapes#dependencies
schemaDependencies[SchemaDependencies]falseApplied schemas if property exists constrainthttp://a.ml/vocabularies/shapes#schemaDependencies
unevaluatedPropertiesboolean-Accepts that properties may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedProperties
unevaluatedPropertiesSchemaShape-Properties that may not be evaluated in schema validationhttp://a.ml/vocabularies/shapes#unevaluatedPropertiesSchema
supportedOperation[ShapeOperation]falseSupported operations for this shapehttp://a.ml/vocabularies/shapes#supportedOperation
inputOnlyboolean-Indicates if the shape is used as schema for input data onlyhttp://a.ml/vocabularies/shapes#inputOnly
keys[Key]falseKeys of this Node Shape in the federated graphhttp://a.ml/vocabularies/federation#keys
externalProperty[ExternalPropertyShape]falseProperties imported from external graphshttp://a.ml/vocabularies/federation#externalProperty
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OAuth1Settings

Settings for an OAuth1 security scheme Types:

  • http://a.ml/vocabularies/security#OAuth1Settings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
requestTokenUristring-http://a.ml/vocabularies/security#requestTokenUri
authorizationUristring-http://a.ml/vocabularies/security#authorizationUri
tokenCredentialsUristring-http://a.ml/vocabularies/security#tokenCredentialsUri
signature[string]falsehttp://a.ml/vocabularies/security#signature
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OAuth2Flow

Flow for an OAuth2 security scheme setting Types:

  • http://a.ml/vocabularies/security#OAuth2Flow
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
authorizationUristring-http://a.ml/vocabularies/security#authorizationUri
accessTokenUristring-http://a.ml/vocabularies/security#accessTokenUri
flowstring-http://a.ml/vocabularies/security#flow
refreshUristring-http://a.ml/vocabularies/security#refreshUri
scope[Scope]falsehttp://a.ml/vocabularies/security#scope
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OAuth2Settings

Settings for an OAuth2 security scheme Types:

  • http://a.ml/vocabularies/security#OAuth2Settings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
authorizationGrant[string]falsehttp://a.ml/vocabularies/security#authorizationGrant
flows[OAuth2Flow]falsehttp://a.ml/vocabularies/security#flows
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ObjType

Types:

NameValueSortedDocumentationNamespace

ObjectNode

Node that represents a dynamic object with records data structure Types:

  • http://a.ml/vocabularies/data#Object
  • http://a.ml/vocabularies/data#Node
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description

ObjectPropertyTerm

Types:

  • http://www.w3.org/2002/07/owl#ObjectProperty
  • http://a.ml/vocabularies/meta#Property
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
displayNamestring-Human readable name for the property termhttp://a.ml/vocabularies/core#displayName
descriptionstring-Human readable description of the property termhttp://a.ml/vocabularies/core#description
rangeurl-Range of the proeprty term, scalar or objecthttp://www.w3.org/2000/01/rdf-schema#range
subPropertyOf[url]falseSubsumption relationship for termshttp://www.w3.org/2000/01/rdf-schema#subPropertyOf
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OpenIdConnectSettings

Settings for an OpenID security scheme Types:

  • http://a.ml/vocabularies/security#OpenIdConnectSettings
  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
openIdConnectUrlstring-http://a.ml/vocabularies/security#openIdConnectUrl
scope[Scope]falsehttp://a.ml/vocabularies/security#scope
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Operation

Action that can be executed using a particular HTTP invocation Types:

  • http://a.ml/vocabularies/apiContract#Operation
  • http://a.ml/vocabularies/core#Operation
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
methodstring-HTTP method required to invoke the operationhttp://a.ml/vocabularies/apiContract#method
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
deprecatedboolean-Marks the operation as deprecatedhttp://a.ml/vocabularies/core#deprecated
guiSummarystring-Human readable description of the operationhttp://a.ml/vocabularies/apiContract#guiSummary
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
scheme[string]falseURI scheme for the API protocolhttp://a.ml/vocabularies/apiContract#scheme
accepts[string]falseMedia-types accepted in a API requesthttp://a.ml/vocabularies/apiContract#accepts
mediaType[string]falseMedia types returned by a API responsehttp://a.ml/vocabularies/core#mediaType
expects[Request]falseRequest information required by the operationhttp://a.ml/vocabularies/apiContract#expects
returns[Response]falseResponse data returned by the operationhttp://a.ml/vocabularies/apiContract#returns
security[SecurityRequirement]falseSecurity schemes applied to an element in the API spechttp://a.ml/vocabularies/security#security
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
callback[Callback]falseAssociated callbackshttp://a.ml/vocabularies/apiContract#callback
server[Server]falseServer informationhttp://a.ml/vocabularies/apiContract#server
bindingOperationBindings-Bindings for this operationhttp://a.ml/vocabularies/apiBinding#binding
isAbstractboolean-Defines a model as abstracthttp://a.ml/vocabularies/apiContract#isAbstract
operationIdstring-Identifier of the target operationhttp://a.ml/vocabularies/apiContract#operationId
federationMetadataOperationFederationMetadata-Metadata about how this Operation should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OperationBindings

Types:

  • http://a.ml/vocabularies/apiBinding#OperationBindings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
bindings[OperationBinding]falseList of operation bindingshttp://a.ml/vocabularies/apiBinding#bindings
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

OperationFederationMetadata

Model that contains data about how the Operation is used in a federated graph Types:

  • http://a.ml/vocabularies/federation#OperationFederationMetadata
  • http://a.ml/vocabularies/federation#FederationMetadata
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
providedEntityNodeShape-Node shape provided by this Operation to the federated graphhttp://a.ml/vocabularies/federation#providedEntity
federationMethodstring-REST method (e.g. GET, POST) used to retrieve an entity. Overrides the Method from the current operationhttp://a.ml/vocabularies/federation#federationMethod
keyMappings[ParameterKeyMapping]falseMapping from parameters to properties from the provided entity to be used for data retrievalhttp://a.ml/vocabularies/federation#keyMappings
namestring-Name element in the federated graphhttp://a.ml/vocabularies/federation#name
tags[string]falseFederation tags of the elementhttp://a.ml/vocabularies/federation#tags
shareableboolean-Element can be defined by more than one component of the federated graphhttp://a.ml/vocabularies/federation#shareable
inaccessibleboolean-Element cannot be accessed by the federated graphhttp://a.ml/vocabularies/federation#inaccessible
overrideFromstring-Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argumenthttp://a.ml/vocabularies/federation#overrideFrom
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Organization

Organization providing an good or service Types:

  • http://a.ml/vocabularies/core#Organization
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
urlurl-URL identifying the organizationhttp://a.ml/vocabularies/core#url
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
emailstring-Contact email for the organizationhttp://a.ml/vocabularies/core#email
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Overlay

Model defining a RAML overlay Types:

  • http://a.ml/vocabularies/apiContract#Overlay
  • http://a.ml/vocabularies/document#Document
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Module
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
extendsurl-Target base unit being extended by this extension modelhttp://a.ml/vocabularies/document#extends
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

Parameter

Piece of data required or returned by an Operation Types:

  • http://a.ml/vocabularies/apiContract#Parameter
  • http://a.ml/vocabularies/core#Parameter
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
paramNamestring-Name of a parameterhttp://a.ml/vocabularies/apiContract#paramName
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
requiredboolean-Marks the parameter as requiredhttp://a.ml/vocabularies/apiContract#required
deprecatedboolean-Marks the parameter as deprecatedhttp://a.ml/vocabularies/document#deprecated
allowEmptyValueboolean-Parameter can be passed without valuehttp://a.ml/vocabularies/apiContract#allowEmptyValue
stylestring-Encoding style for the parameter informationhttp://a.ml/vocabularies/apiContract#style
explodeboolean-http://a.ml/vocabularies/apiContract#explode
allowReservedboolean-http://a.ml/vocabularies/apiContract#allowReserved
bindingstring-Part of the Request model where the parameter can be encoded (header, path, query param, etc.)http://a.ml/vocabularies/apiContract#binding
schemaShape-Schema the parameter value must validatehttp://a.ml/vocabularies/shapes#schema
payload[Payload]falsehttp://a.ml/vocabularies/apiContract#payload
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
defaultValueDataNode-Default value parsed for a parameterhttp://a.ml/vocabularies/core#defaultValue
federationMetadataParameterFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParameterFederationMetadata

Model that contains data about how the Shape should be federated Types:

  • http://a.ml/vocabularies/federation#ParameterFederationMetadata
  • http://a.ml/vocabularies/federation#FederationMetadata
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name element in the federated graphhttp://a.ml/vocabularies/federation#name
tags[string]falseFederation tags of the elementhttp://a.ml/vocabularies/federation#tags
shareableboolean-Element can be defined by more than one component of the federated graphhttp://a.ml/vocabularies/federation#shareable
inaccessibleboolean-Element cannot be accessed by the federated graphhttp://a.ml/vocabularies/federation#inaccessible
overrideFromstring-Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argumenthttp://a.ml/vocabularies/federation#overrideFrom
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParameterKeyMapping

Model that indicates how other elements map to a federation Key's components Types:

  • http://a.ml/vocabularies/federation#ParameterKeyMapping
  • http://a.ml/vocabularies/federation#KeyMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
mappingSourceParameter-Parameter to use as source for this mappinghttp://a.ml/vocabularies/federation#mappingSource
mappingTargetPropertyShapePath-Path to target Property Shape of this mappinghttp://a.ml/vocabularies/federation#mappingTarget
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParametrizedDeclaration

Generic graph template supporting variables that can be transformed into a domain element Types:

  • http://a.ml/vocabularies/document#ParametrizedDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
targetAbstractDeclaration-Target node for the parameterhttp://a.ml/vocabularies/document#target
variable[VariableValue]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParametrizedResourceType

RAML resource type that can accept parameters Types:

  • http://a.ml/vocabularies/apiContract#ParametrizedResourceType
  • http://a.ml/vocabularies/document#ParametrizedDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
targetAbstractDeclaration-Target node for the parameterhttp://a.ml/vocabularies/document#target
variable[VariableValue]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParametrizedSecurityScheme

Types:

  • http://a.ml/vocabularies/security#ParametrizedSecurityScheme
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name for the security schemehttp://a.ml/vocabularies/core#name
schemeSecurityScheme-http://a.ml/vocabularies/security#scheme
settingsSettings-Security scheme settingshttp://a.ml/vocabularies/security#settings
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ParametrizedTrait

RAML trait with declared parameters Types:

  • http://a.ml/vocabularies/apiContract#ParametrizedTrait
  • http://a.ml/vocabularies/document#ParametrizedDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
targetAbstractDeclaration-Target node for the parameterhttp://a.ml/vocabularies/document#target
variable[VariableValue]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Payload

Encoded payload using certain media-type Types:

  • http://a.ml/vocabularies/apiContract#Payload
  • http://a.ml/vocabularies/core#Payload
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
mediaTypestring-Media types supported in the payloadhttp://a.ml/vocabularies/core#mediaType
schemaMediaTypestring-Defines the format of the payload schemahttp://a.ml/vocabularies/apiContract#schemaMediaType
schemaShape-Schema associated to this payloadhttp://a.ml/vocabularies/shapes#schema
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
encoding[Encoding]falseAn array of properties and its encoding information. The key, being the property name, must exist in the schema as a propertyhttp://a.ml/vocabularies/apiContract#encoding
requiredboolean-Marks the payload as requiredhttp://a.ml/vocabularies/apiContract#required
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

PayloadFragment

Fragment encoding HTTP payload information Types:

  • http://a.ml/vocabularies/apiContract#PayloadFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
mediaTypestring-HTTP Media type associated to the encoded fragment informationhttp://a.ml/vocabularies/core#mediaType
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

PropertyDependencies

Dependency between sets of property shapes Types:

  • http://a.ml/vocabularies/shapes#PropertyDependencies
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
propertySourcestring-Source property name in the dependencyhttp://a.ml/vocabularies/shapes#propertySource
propertyTarget[string]falseTarget property name in the dependencyhttp://a.ml/vocabularies/shapes#propertyTarget
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PropertyKeyMapping

Model that indicates how other elements map to a federation Key's components Types:

  • http://a.ml/vocabularies/federation#PropertyKeyMapping
  • http://a.ml/vocabularies/federation#KeyMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
mappingSourcePropertyShape-Property Shape to use as source for this mappinghttp://a.ml/vocabularies/federation#mappingSource
mappingTargetstring-Name of external target Property Shape of this mappinghttp://a.ml/vocabularies/federation#mappingTarget
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PropertyMapping

Semantic mapping from an input AST in a dialect document to the output graph of information for a class of output node Types:

  • http://a.ml/vocabularies/meta#NodePropertyMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
pathurl-URI for the mapped graph property derived from this mappinghttp://www.w3.org/ns/shacl#path
namestring-Name in the source AST for the mappinghttp://a.ml/vocabularies/core#name
datatypeurl-Scalar constraint over the type of the mapped graph propertyhttp://www.w3.org/ns/shacl#datatype
node[url]trueObject constraint over the type of the mapped graph propertyhttp://www.w3.org/ns/shacl#node
mapPropertystring-Marks the mapping as a 'map' mapping syntax. Directly related with mapTermKeyPropertyhttp://a.ml/vocabularies/meta#mapProperty
mapValuePropertystring-Marks the mapping as a 'map value' mapping syntax. Directly related with mapTermValuePropertyhttp://a.ml/vocabularies/meta#mapValueProperty
mapTermPropertyurl-Marks the mapping as a 'map' mapping syntax.http://a.ml/vocabularies/meta#mapTermProperty
mapTermValuePropertyurl-Marks the mapping as a 'map value' mapping syntaxhttp://a.ml/vocabularies/meta#mapTermValueProperty
minCountint-Minimum count constraint over the mapped propertyhttp://www.w3.org/ns/shacl#minCount
patternstring-Pattern constraint over the mapped propertyhttp://www.w3.org/ns/shacl#pattern
minInclusivedouble-Minimum inclusive constraint over the mapped propertyhttp://www.w3.org/ns/shacl#minInclusive
maxInclusivedouble-Maximum inclusive constraint over the mapped propertyhttp://www.w3.org/ns/shacl#maxInclusive
allowMultipleboolean-Allows multiple mapped nodes for the property mappinghttp://a.ml/vocabularies/meta#allowMultiple
sortedboolean-Marks the mapping as requiring order in the mapped collection of nodeshttp://a.ml/vocabularies/meta#sorted
in[Any]trueEnum constraint for the values of the property mappinghttp://www.w3.org/ns/shacl#in
typeDiscriminatorMapstring-Information about the discriminator values in the source AST for the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorMap
uniqueboolean-Marks the values for the property mapping as a primary key for this type of nodehttp://a.ml/vocabularies/meta#unique
externallyLinkableboolean-Marks this object property as supporting external linkshttp://a.ml/vocabularies/meta#externallyLinkable
mandatoryboolean-Mandatory constraint over the property. Different from minCount because it only checks the presence of propertyhttp://www.w3.org/ns/shacl#mandatory
typeDiscriminatorNamestring-Information about the field in the source AST to be used as discrimintaro in the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorName
mergePolicystring-Indication of how to merge this graph node when applying a patch documenthttp://a.ml/vocabularies/meta#mergePolicy
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PropertyShape

Constraint over a property in a data shape. Types:

  • http://www.w3.org/ns/shacl#PropertyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
pathurl-Path to the constrained propertyhttp://www.w3.org/ns/shacl#path
rangeShape-Range property constrainthttp://a.ml/vocabularies/shapes#range
minCountint-Minimum count property constrainthttp://www.w3.org/ns/shacl#minCount
maxCountint-Maximum count property constrainthttp://www.w3.org/ns/shacl#maxCount
patternNamestring-Patterned property constrainthttp://a.ml/vocabularies/shapes#patternName
serializationOrderint-position in the set of properties for a shape used to serialize this property on the wirehttp://a.ml/vocabularies/shapes#serializationOrder
requires[PropertyShapePath]falseExternal properties (by path) required to retrieve data from this property during federationhttp://a.ml/vocabularies/federation#requires
provides[PropertyShapePath]falseExternal properties (by path) that can be provided by this graph during federationhttp://a.ml/vocabularies/federation#provides
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PropertyShapePath

Model that represents a property shape path in a traversal to reach a particular Shape Types:

  • http://a.ml/vocabularies/shapes#PropertyShapePath
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
path[PropertyShape]truerepresents a property shape path in a traversal to reach a particular Shapehttp://a.ml/vocabularies/shapes#path
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PublicNodeMapping

Mapping for a graph node mapping to a particular function in a dialect Types:

  • http://a.ml/vocabularies/meta#PublicNodeMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the mappinghttp://a.ml/vocabularies/core#name
mappedNodeurl-Node in the dialect definition associated to this mappinghttp://a.ml/vocabularies/meta#mappedNode
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PulsarChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#PulsarChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namespacestring-The namespace the channel is associated with.http://a.ml/vocabularies/apiBinding#namespace
persistencestring-Persistence of the topic in Pulsar. It MUST be either persistent or non-persistent.http://a.ml/vocabularies/apiBinding#persistence
compactionint-Topic compaction threshold given in Megabytes.http://a.ml/vocabularies/apiBinding#compaction
geo-replication[string]falseA list of clusters the topic is replicated to.http://a.ml/vocabularies/apiBinding#geo-replication
retentionPulsarChannelRetention-Topic retention policy.http://a.ml/vocabularies/apiBinding#retention
ttlint-Message time-to-live in seconds.http://a.ml/vocabularies/apiBinding#ttl
deduplicationboolean-Message deduplication. When true, it ensures that each message produced on Pulsar topics is persisted to disk only once.http://a.ml/vocabularies/apiBinding#deduplication
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PulsarChannelRetention

Types:

  • http://a.ml/vocabularies/apiBinding#PulsarChannelRetention
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
timeint-Time given in Minutes. Defaults to 0http://a.ml/vocabularies/apiBinding#time
sizeint-Size given in MegaBytes. Defaults to 0http://a.ml/vocabularies/apiBinding#size
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

PulsarServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#PulsarServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
tenantstring-The pulsar tenant. If omitted, "public" MUST be assumed.http://a.ml/vocabularies/apiBinding#tenant
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

RecursiveShape

Recursion on a Shape structure, used when expanding a shape and finding the canonical representation of that shape. Types:

  • http://a.ml/vocabularies/shapes#RecursiveShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
fixPointurl-Link to the base of the recursion for a recursive shapehttp://a.ml/vocabularies/shapes#fixPoint
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Request

Request information for an operation Types:

  • http://a.ml/vocabularies/apiContract#Request
  • http://a.ml/vocabularies/core#Request
  • http://a.ml/vocabularies/apiContract#Message
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
requiredboolean-Marks the parameter as requiredhttp://a.ml/vocabularies/apiContract#required
parameter[Parameter]falseParameters associated to the communication modelhttp://a.ml/vocabularies/apiContract#parameter
queryStringShape-Query string for the communication modelhttp://a.ml/vocabularies/apiContract#queryString
uriParameter[Parameter]falsehttp://a.ml/vocabularies/apiContract#uriParameter
cookieParameter[Parameter]falsehttp://a.ml/vocabularies/apiContract#cookieParameter
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
payload[Payload]falsePayload for a Request/Responsehttp://a.ml/vocabularies/apiContract#payload
correlationIdCorrelationId-An identifier that can be used for message tracing and correlationhttp://a.ml/vocabularies/core#correlationId
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
titlestring-Title of the itemhttp://a.ml/vocabularies/core#title
summarystring-Human readable short description of the request/responsehttp://a.ml/vocabularies/core#summary
header[Parameter]falseParameter passed as a header to an operation for communication modelshttp://a.ml/vocabularies/apiContract#header
bindingMessageBindings-Bindings for this request/responsehttp://a.ml/vocabularies/apiBinding#binding
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
isAbstractboolean-Defines a model as abstracthttp://a.ml/vocabularies/apiContract#isAbstract
headerExamples[Example]falseExamples for a header definitionhttp://a.ml/vocabularies/apiContract#headerExamples
headerSchemaNodeShape-Object Schema who's properties are headers for the message.http://a.ml/vocabularies/apiContract#headerSchema
messageIdstring-Unique Id for request and response messagehttp://a.ml/vocabularies/apiContract#messageId
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ResourceType

Type of document base unit encoding a RAML resource type Types:

  • http://a.ml/vocabularies/apiContract#ResourceType
  • http://a.ml/vocabularies/document#AbstractDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
dataNodeDataNode-Associated dynamic structure for the declarationhttp://a.ml/vocabularies/document#dataNode
variable[string]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ResourceTypeFragment

Fragment encoding a RAML resource type Types:

  • http://a.ml/vocabularies/apiContract#ResourceTypeFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

Response

Response information for an operation Types:

  • http://a.ml/vocabularies/apiContract#Response
  • http://a.ml/vocabularies/core#Response
  • http://a.ml/vocabularies/apiContract#Message
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
statusCodestring-HTTP status code returned by a responsehttp://a.ml/vocabularies/apiContract#statusCode
link[TemplatedLink]falseStructural definition of links on the source data shape ASThttp://a.ml/vocabularies/apiContract#link
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
payload[Payload]falsePayload for a Request/Responsehttp://a.ml/vocabularies/apiContract#payload
correlationIdCorrelationId-An identifier that can be used for message tracing and correlationhttp://a.ml/vocabularies/core#correlationId
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
titlestring-Title of the itemhttp://a.ml/vocabularies/core#title
summarystring-Human readable short description of the request/responsehttp://a.ml/vocabularies/core#summary
header[Parameter]falseParameter passed as a header to an operation for communication modelshttp://a.ml/vocabularies/apiContract#header
bindingMessageBindings-Bindings for this request/responsehttp://a.ml/vocabularies/apiBinding#binding
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
isAbstractboolean-Defines a model as abstracthttp://a.ml/vocabularies/apiContract#isAbstract
headerExamples[Example]falseExamples for a header definitionhttp://a.ml/vocabularies/apiContract#headerExamples
headerSchemaNodeShape-Object Schema who's properties are headers for the message.http://a.ml/vocabularies/apiContract#headerSchema
messageIdstring-Unique Id for request and response messagehttp://a.ml/vocabularies/apiContract#messageId
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ScalarNode

Node that represents a dynamic scalar value data structure Types:

  • http://a.ml/vocabularies/data#Scalar
  • http://a.ml/vocabularies/data#Node
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
valuestring-value for an scalar dynamic nodehttp://a.ml/vocabularies/data#value
datatypeurl-Data type of value for an scalar dynamic nodehttp://www.w3.org/ns/shacl#datatype
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ScalarShape

Data shape describing a scalar value in the input data model, reified as an scalar node in the mapped graph Types:

  • http://a.ml/vocabularies/shapes#ScalarShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
datatypeurl-Scalar range constraining this scalar shapehttp://www.w3.org/ns/shacl#datatype
encodingstring-Describes the contents' value encodinghttp://a.ml/vocabularies/shapes#encoding
mediaTypestring-Describes the content's value mediatypehttp://a.ml/vocabularies/shapes#mediaType
contentSchemaShape-Describes the content's value structurehttp://a.ml/vocabularies/shapes#contentSchema
patternstring-Pattern constrainthttp://www.w3.org/ns/shacl#pattern
minLengthint-Minimum lenght constrainthttp://www.w3.org/ns/shacl#minLength
maxLengthint-Maximum length constrainthttp://www.w3.org/ns/shacl#maxLength
minInclusivedouble-Minimum inclusive constrainthttp://www.w3.org/ns/shacl#minInclusive
maxInclusivedouble-Maximum inclusive constrainthttp://www.w3.org/ns/shacl#maxInclusive
minExclusiveboolean-Minimum exclusive constrainthttp://www.w3.org/ns/shacl#minExclusive
maxExclusiveboolean-Maximum exclusive constrainthttp://www.w3.org/ns/shacl#maxExclusive
exclusiveMinimumNumericdouble-Minimum exclusive constrainthttp://a.ml/vocabularies/shapes#exclusiveMinimumNumeric
exclusiveMaximumNumericdouble-Maximum exclusive constrainthttp://a.ml/vocabularies/shapes#exclusiveMaximumNumeric
formatstring-Format constrainthttp://a.ml/vocabularies/shapes#format
multipleOfdouble-Multiple of constrainthttp://a.ml/vocabularies/shapes#multipleOf
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SchemaDependencies

Dependency between a property shape and a schema Types:

  • http://a.ml/vocabularies/shapes#SchemaDependencies
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
propertySourcestring-Source property name in the dependencyhttp://a.ml/vocabularies/shapes#propertySource
schemaTargetShape-Target applied shape in the dependencyhttp://a.ml/vocabularies/shapes#schemaTarget
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SchemaShape

Raw schema that cannot be parsed using AMF shapes model Types:

  • http://a.ml/vocabularies/shapes#SchemaShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
mediaTypestring-Media type associated to a shapehttp://a.ml/vocabularies/core#mediaType
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Scope

Types:

  • http://a.ml/vocabularies/security#Scope
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the scopehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description for the scopehttp://a.ml/vocabularies/core#description
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SecurityRequirement

Flow for an OAuth2 security scheme setting Types:

  • http://a.ml/vocabularies/security#SecurityRequirement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
schemes[ParametrizedSecurityScheme]falsehttp://a.ml/vocabularies/security#schemes
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SecurityScheme

Authentication and access control mechanism defined in an API Types:

  • http://a.ml/vocabularies/security#SecurityScheme
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name for the security schemehttp://a.ml/vocabularies/core#name
typestring-Type of security schemehttp://a.ml/vocabularies/security#type
displayNamestring-Human readable name for the termhttp://a.ml/vocabularies/core#displayName
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
header[Parameter]falseParameter passed as a header to an operation for communication modelshttp://a.ml/vocabularies/apiContract#header
parameter[Parameter]falseParameters associated to the communication modelhttp://a.ml/vocabularies/apiContract#parameter
response[Response]falseResponse associated to this security schemehttp://a.ml/vocabularies/apiContract#response
settingsSettings-Security scheme settingshttp://a.ml/vocabularies/security#settings
queryStringShape-Query string for the communication modelhttp://a.ml/vocabularies/apiContract#queryString
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SecuritySchemeFragment

Fragment encoding a RAML security scheme Types:

  • http://a.ml/vocabularies/security#SecuritySchemeFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

SemanticContext

Set of semantic contextual information that can be attached to a schema Types:

  • http://a.ml/vocabularies/meta#SemanticContext
NameValueSortedDocumentationNamespace
baseBaseIRI-Base IRI used to generate all the @ids in the modelhttp://a.ml/vocabularies/meta#base
vocabDefaultVocabulary-Default IRI prefix used to map by default all properties and terms in the modelhttp://a.ml/vocabularies/meta#vocab
curies[CuriePrefix]falseSet of CURIE prefixes defined in a contexthttp://a.ml/vocabularies/meta#curies
mappings[ContextMapping]falseSet of property mappings and coercions defined in a contexthttp://a.ml/vocabularies/meta#mappings

SemanticExtension

Mapping a particular extension name to an extension definition Types:

  • http://a.ml/vocabularies/meta#ExtensionMapping
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name that identifies an extension in the target documenthttp://a.ml/vocabularies/core#name
extensionMappingDefinitionurl-Extension mapping (annotation mapping) definition used to parse a certain extension identified with the ExtensionNamehttp://a.ml/vocabularies/meta#extensionMappingDefinition
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Server

Information about the network accessible locations where the API is available Types:

  • http://a.ml/vocabularies/apiContract#Server
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
urlTemplatestring-URL (potentially a template) for the serverhttp://a.ml/vocabularies/core#urlTemplate
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
tags[Parameter]falseTags for the different Servershttp://a.ml/vocabularies/apiContract#tags
variable[Parameter]falseVariables in the URL for the serverhttp://a.ml/vocabularies/apiContract#variable
protocolstring-The protocol this URL supports for connectionhttp://a.ml/vocabularies/apiContract#protocol
protocolVersionstring-The version of the protocol used for connectionhttp://a.ml/vocabularies/apiContract#protocolVersion
security[SecurityRequirement]falseTextual indication of the kind of security scheme usedhttp://a.ml/vocabularies/security#security
bindingServerBindings-Bindings for this serverhttp://a.ml/vocabularies/apiBinding#binding
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ServerBindings

Types:

  • http://a.ml/vocabularies/apiBinding#ServerBindings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
bindings[ServerBinding]falseList of server bindingshttp://a.ml/vocabularies/apiBinding#bindings
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Settings

Settings for a security scheme Types:

  • http://a.ml/vocabularies/security#Settings
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
additionalPropertiesDataNode-http://a.ml/vocabularies/security#additionalProperties
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Shape

Base class for all shapes. Shapes are Domain Entities that define constraints over parts of a data graph. They can be used to define and enforce schemas for the data graph information through SHACL. Shapes can be recursive and inherit from other shapes. Types:

  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub

ShapeExtension

Custom extensions for a data shape definition inside an API definition Types:

  • http://a.ml/vocabularies/apiContract#ShapeExtension
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
definedByCustomDomainProperty-Definition for the extended entityhttp://a.ml/vocabularies/document#definedBy
extensionDataNode-Data structure associated to the extensionhttp://a.ml/vocabularies/document#extension
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ShapeFederationMetadata

Model that contains data about how the Shape should be federated Types:

  • http://a.ml/vocabularies/federation#ShapeFederationMetadata
  • http://a.ml/vocabularies/federation#FederationMetadata
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name element in the federated graphhttp://a.ml/vocabularies/federation#name
tags[string]falseFederation tags of the elementhttp://a.ml/vocabularies/federation#tags
shareableboolean-Element can be defined by more than one component of the federated graphhttp://a.ml/vocabularies/federation#shareable
inaccessibleboolean-Element cannot be accessed by the federated graphhttp://a.ml/vocabularies/federation#inaccessible
overrideFromstring-Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argumenthttp://a.ml/vocabularies/federation#overrideFrom
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ShapeOperation

Action that can be executed over the data of a particular shape Types:

  • http://a.ml/vocabularies/shapes#Operation
  • http://a.ml/vocabularies/core#Operation
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
expects[ShapeRequest]falseRequest information required by the operationhttp://a.ml/vocabularies/shapes#expects
returns[ShapeResponse]falseResponse data returned by the operationhttp://a.ml/vocabularies/shapes#returns
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ShapeParameter

Piece of data required or returned by an Operation Types:

  • http://a.ml/vocabularies/shapes#Parameter
  • http://a.ml/vocabularies/core#Parameter
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
paramNamestring-Name of a parameterhttp://a.ml/vocabularies/shapes#paramName
bindingstring-Part of the Request model where the parameter can be encoded (header, path, query param, etc.)http://a.ml/vocabularies/shapes#binding
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
requiredboolean-Marks the parameter as requiredhttp://a.ml/vocabularies/shapes#required
schemaShape-Schema the parameter value must validatehttp://a.ml/vocabularies/shapes#schema
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
defaultValueDataNode-Default value parsed for a parameterhttp://a.ml/vocabularies/core#defaultValue
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

ShapePayload

Encoded payload using certain media-type Types:

  • http://a.ml/vocabularies/shapes#Payload
  • http://a.ml/vocabularies/core#Payload
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
schemaShape-Schema associated to this payloadhttp://a.ml/vocabularies/shapes#schema
mediaTypestring-Media types supported in the payloadhttp://a.ml/vocabularies/core#mediaType
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

ShapeRequest

Request information for an operation Types:

  • http://a.ml/vocabularies/shapes#Request
  • http://a.ml/vocabularies/core#Request
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
parameter[ShapeParameter]falseParameters associated to the communication modelhttp://a.ml/vocabularies/shapes#parameter

ShapeResponse

Response information for an operation Types:

  • http://a.ml/vocabularies/shapes#Response
  • http://a.ml/vocabularies/core#Response
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
payloadShapePayload-Payload for a Request/Responsehttp://a.ml/vocabularies/shapes#payload

SolaceOperationBinding

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationBinding
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinations[SolaceOperationDestination]falsehttp://a.ml/vocabularies/apiBinding#destinations
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationBinding010
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinations[SolaceOperationDestination010]falsehttp://a.ml/vocabularies/apiBinding#destinations
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationBinding020

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationBinding020
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinations[SolaceOperationDestination020]falsehttp://a.ml/vocabularies/apiBinding#destinations
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationBinding030

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationBinding030
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinations[SolaceOperationDestination030]falsehttp://a.ml/vocabularies/apiBinding#destinations
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationBinding040

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationBinding040
  • http://a.ml/vocabularies/apiBinding#OperationBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinations[SolaceOperationDestination040]falsehttp://a.ml/vocabularies/apiBinding#destinations
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
timeToLiveint-Interval in milliseconds or a Schema Object containing the definition of the lifetime of the message.http://a.ml/vocabularies/apiBinding#timeToLive
priorityint-The valid priority value range is 0-255 with 0 as the lowest priority and 255 as the highest or a Schema Object containing the definition of the priority.http://a.ml/vocabularies/apiBinding#priority
dmqEligibleboolean-Set the message to be eligible to be moved to a Dead Message Queue. The default value is false.http://a.ml/vocabularies/apiBinding#dmqEligible
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationDestination

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationDestination010

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination010
  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue010-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationDestination020

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination020
  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue010-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
topicSolaceOperationTopic-Defines the properties of a topic.http://a.ml/vocabularies/apiBinding#topic
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationDestination030

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination030
  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue030-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
topicSolaceOperationTopic-Defines the properties of a topic.http://a.ml/vocabularies/apiBinding#topic
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationDestination040

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination040
  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue030-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
bindingVersionstring-The binding version.http://a.ml/vocabularies/apiBinding#bindingVersion
topicSolaceOperationTopic-Defines the properties of a topic.http://a.ml/vocabularies/apiBinding#topic
destinationTypestring-'queue' or 'topic'. If the type is queue, then the subscriber can bind to the queue, which in turn will subscribe to the topic as represented by the channel name or to the provided topicSubscriptions.http://a.ml/vocabularies/apiBinding#destinationType
deliveryModestring-'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'.http://a.ml/vocabularies/apiBinding#deliveryMode
queueSolaceOperationQueue-Defines the properties of a queue.http://a.ml/vocabularies/apiBinding#queue
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationQueue

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationQueue
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicSubscriptions[string]falseA list of topics that the queue subscribes to, only applicable when destinationType is 'queue'. If none is given, the queue subscribes to the topic as represented by the channel name.http://a.ml/vocabularies/apiBinding#topicSubscriptions
accessTypestring-'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'.http://a.ml/vocabularies/apiBinding#accessType
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationQueue010

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationQueue010
  • http://a.ml/vocabularies/apiBinding#SolaceOperationQueue
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicSubscriptions[string]falseA list of topics that the queue subscribes to, only applicable when destinationType is 'queue'. If none is given, the queue subscribes to the topic as represented by the channel name.http://a.ml/vocabularies/apiBinding#topicSubscriptions
accessTypestring-'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'.http://a.ml/vocabularies/apiBinding#accessType
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationQueue030

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationQueue030
  • http://a.ml/vocabularies/apiBinding#SolaceOperationDestination
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
maxMsgSpoolSizestring-The maximum size of the message spool used by the queue.http://a.ml/vocabularies/apiBinding#maxMsgSpoolSize
maxTtlstring-The maximum time-to-live for messages in the queue.http://a.ml/vocabularies/apiBinding#maxTtl
topicSubscriptions[string]falseA list of topics that the queue subscribes to, only applicable when destinationType is 'queue'. If none is given, the queue subscribes to the topic as represented by the channel name.http://a.ml/vocabularies/apiBinding#topicSubscriptions
accessTypestring-'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'.http://a.ml/vocabularies/apiBinding#accessType
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceOperationTopic

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceOperationTopic
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
topicSubscriptions[string]falseA list of topics that the client subscribes to, only applicable when destinationType is 'topic'. If none is given, the client subscribes to the topic as represented by the channel name.http://a.ml/vocabularies/apiBinding#topicSubscriptions
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceServerBinding

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
msgVpnstring-The Virtual Private Network name on the Solace broker.http://a.ml/vocabularies/apiBinding#msgVpn
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceServerBinding010

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceServerBinding010
  • http://a.ml/vocabularies/apiBinding#SolaceServerBinding
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
msgVpnstring-The Virtual Private Network name on the Solace broker.http://a.ml/vocabularies/apiBinding#msgVpn
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SolaceServerBinding040

Types:

  • http://a.ml/vocabularies/apiBinding#SolaceServerBinding040
  • http://a.ml/vocabularies/apiBinding#ServerBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
msgVpnstring-The Virtual Private Network name on the Solace broker.http://a.ml/vocabularies/apiBinding#msgVpn
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
clientNamestring-A unique client name to use to register to the appliance. If specified, it must be a valid Topic name, and a maximum of 160 bytes in length when encoded as UTF-8.http://a.ml/vocabularies/apiBinding#clientName
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

SourceMap

SourceMaps include tags with syntax specific information obtained when parsing a particular specification syntax like RAML or OpenAPI. It can be used to re-generate the document from the RDF model with a similar syntax Types:

  • http://a.ml/vocabularies/document-source-maps#SourceMap
NameValueSortedDocumentationNamespace

Tag

Categorical information provided by some API spec format. Tags are extensions to the model supported directly in the input API spec format. Types:

  • http://a.ml/vocabularies/apiContract#Tag
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
documentationCreativeWork-Documentation about the taghttp://a.ml/vocabularies/core#documentation
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Templated link containing URL template and variables mapping Types:

  • http://a.ml/vocabularies/apiContract#TemplatedLink
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
templatestring-URL template for a templated linkhttp://a.ml/vocabularies/apiContract#template
operationIdstring-Identifier of the target operationhttp://a.ml/vocabularies/apiContract#operationId
mapping[IriTemplateMapping]falseVariable mapping for the URL templatehttp://a.ml/vocabularies/apiContract#mapping
requestBodystring-http://a.ml/vocabularies/apiContract#requestBody
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
serverServer-http://a.ml/vocabularies/apiContract#server
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive

Trait

Type of document base unit encoding a RAML trait Types:

  • http://a.ml/vocabularies/apiContract#Trait
  • http://a.ml/vocabularies/document#AbstractDeclaration
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
dataNodeDataNode-Associated dynamic structure for the declarationhttp://a.ml/vocabularies/document#dataNode
variable[string]falseVariables to be replaced in the graph template introduced by an AbstractDeclarationhttp://a.ml/vocabularies/document#variable
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

TraitFragment

Fragment encoding a RAML trait Types:

  • http://a.ml/vocabularies/apiContract#TraitFragment
  • http://a.ml/vocabularies/document#Fragment
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
encodesDomainElement-The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains.http://a.ml/vocabularies/document#encodes
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

TupleShape

Data shape containing a multi-valued collection of shapes Types:

  • http://a.ml/vocabularies/shapes#TupleShape
  • http://a.ml/vocabularies/shapes#ArrayShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
items[Shape]trueShapes contained in the Tuple Shapehttp://a.ml/vocabularies/shapes#items
minCountint-Minimum items count constrainthttp://www.w3.org/ns/shacl#minCount
maxCountint-Maximum items count constrainthttp://www.w3.org/ns/shacl#maxCount
uniqueItemsboolean-Unique items constrainthttp://a.ml/vocabularies/shapes#uniqueItems
closedItemsboolean-Constraint limiting additional shapes in the collectionhttp://a.ml/vocabularies/shapes#closedItems
additionalItemsSchemaShape-Controls whether it’s valid to have additional items in the array beyond what is definedhttp://a.ml/vocabularies/shapes#additionalItemsSchema
collectionFormatstring-Input collection format informationhttp://a.ml/vocabularies/shapes#collectionFormat
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

UnionNodeMapping

Types:

  • http://a.ml/vocabularies/meta#UnionNodeMapping
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the node mappable elementhttp://a.ml/vocabularies/core#name
typeDiscriminatorMapstring-Information about the discriminator values in the source AST for the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorMap
typeDiscriminatorNamestring-Information about the field in the source AST to be used as discrimintaro in the property mappinghttp://a.ml/vocabularies/meta#typeDiscriminatorName
node[url]trueObject constraint over the type of the mapped graph propertyhttp://www.w3.org/ns/shacl#node
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends
and[url]falseLogical and composition of datahttp://a.ml/vocabularies/amf/aml#and
or[url]falseLogical or composition of datahttp://a.ml/vocabularies/amf/aml#or
components[url]falseArray of component mappings in case of component combination generated mappinghttp://a.ml/vocabularies/amf/aml#components
ifurl-Conditional constraint if over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#if
thenurl-Conditional constraint then over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#then
elseurl-Conditional constraint else over the type of the mapped graph propertyhttp://a.ml/vocabularies/amf/aml#else

UnionShape

Shape representing the union of many alternative data shapes Types:

  • http://a.ml/vocabularies/shapes#UnionShape
  • http://a.ml/vocabularies/shapes#AnyShape
  • http://www.w3.org/ns/shacl#Shape
  • http://a.ml/vocabularies/shapes#Shape
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
anyOf[Shape]falseData shapes in the unionhttp://a.ml/vocabularies/shapes#anyOf
link-targeturl-URI of the linked elementhttp://a.ml/vocabularies/document#link-target
link-labelstring-Label for the type of linkhttp://a.ml/vocabularies/document#link-label
recursiveboolean-Indication taht this kind of linkable element can support recursive linkshttp://a.ml/vocabularies/document#recursive
namestring-Name for a data shapehttp://www.w3.org/ns/shacl#name
namestring-Human readable name for the termhttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
defaultValueDataNode-Default value parsed for a data shape propertyhttp://www.w3.org/ns/shacl#defaultValue
in[DataNode]trueEnumeration of possible values for a data shape propertyhttp://www.w3.org/ns/shacl#in
inherits[Shape]falseRelationship of inheritance between data shapeshttp://a.ml/vocabularies/shapes#inherits
defaultValueStrstring-Textual representation of the parsed default value for the shape propertyhttp://www.w3.org/ns/shacl#defaultValueStr
notShape-Logical not composition of data shapeshttp://www.w3.org/ns/shacl#not
and[Shape]falseLogical and composition of data shapeshttp://www.w3.org/ns/shacl#and
or[Shape]falseLogical or composition of data shapeshttp://www.w3.org/ns/shacl#or
xone[Shape]falseLogical exclusive or composition of data shapeshttp://www.w3.org/ns/shacl#xone
closure[url]falseTransitive closure of data shapes this particular shape inherits structure fromhttp://a.ml/vocabularies/shapes#closure
ifShape-Condition for applying composition of data shapeshttp://www.w3.org/ns/shacl#if
thenShape-Composition of data shape when if data shape is validhttp://www.w3.org/ns/shacl#then
elseShape-Composition of data shape when if data shape is invalidhttp://www.w3.org/ns/shacl#else
readOnlyboolean-Read only property constrainthttp://a.ml/vocabularies/shapes#readOnly
writeOnlyboolean-Write only property constrainthttp://a.ml/vocabularies/shapes#writeOnly
serializationSchemaShape-Serialization schema for a shapehttp://a.ml/vocabularies/shapes#serializationSchema
deprecatedboolean-Deprecated annotation for a property constrainthttp://a.ml/vocabularies/shapes#deprecated
isExtensionboolean-Indicates if a Shape is an extension of another shape or a standalone shapehttp://a.ml/vocabularies/shapes#isExtension
federationMetadataShapeFederationMetadata-Metadata about how this DomainElement should be federatedhttp://a.ml/vocabularies/federation#federationMetadata
isStubboolean-Indicates if an element is a stub from an external component from another component of the federated graphhttp://a.ml/vocabularies/federation#isStub
documentationCreativeWork-Documentation for a particular part of the modelhttp://a.ml/vocabularies/core#documentation
xmlSerializationXMLSerializer-Information about how to serializehttp://a.ml/vocabularies/shapes#xmlSerialization
commentstring-A comment on an item. The comment's content is expressed via the texthttp://a.ml/vocabularies/core#comment
schemaVersionstring-Determine which dialect should be used when processing the schemahttp://a.ml/vocabularies/shapes#schemaVersion
examples[Example]falseExamples for a particular domain elementhttp://a.ml/vocabularies/apiContract#examples
namespacestring-(AVRO) a JSON string that qualifies the namehttp://a.ml/vocabularies/shapes#namespace
aliases[string]false(AVRO) a JSON array of strings, providing alternate names for this shapehttp://a.ml/vocabularies/shapes#aliases
sizeint-(AVRO) an integer specifying the number of bytes per valuehttp://a.ml/vocabularies/shapes#size
rawstring-Raw textual information that cannot be processed for the current model semantics.http://a.ml/vocabularies/document#raw
reference-idurl-Internal identifier for an inlined fragmenthttp://a.ml/vocabularies/document#reference-id
locationstring-Location of an inlined fragmenthttp://a.ml/vocabularies/document#location
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

VariableValue

Value for a variable in a graph template Types:

  • http://a.ml/vocabularies/document#VariableValue
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-name of the template variablehttp://a.ml/vocabularies/core#name
valueDataNode-value of the variableshttp://a.ml/vocabularies/document#value
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

Vocabulary

Basic primitives for the declaration of vocabularies. Types:

  • http://a.ml/vocabularies/meta#Vocabulary
  • http://www.w3.org/2002/07/owl#Ontology
  • http://a.ml/vocabularies/document#Unit
NameValueSortedDocumentationNamespace
namestring-Name for an entityhttp://a.ml/vocabularies/core#name
imports[VocabularyReference]falseimport relationships between vocabularieshttp://www.w3.org/2002/07/owl#imports
externals[External]falsehttp://a.ml/vocabularies/meta#externals
declares[DomainElement]falseThe declares relationship exposes a DomainElement as a re-usable unit that can be referenced from other units. URIs for the declared DomainElement are considered to be stable and safe to reference from other DomainElements.http://a.ml/vocabularies/document#declares
basestring-Base URI prefix for definitions in this vocabularyhttp://a.ml/vocabularies/meta#base
locationstring-Location of the metadata document that generated this base unithttp://a.ml/vocabularies/document#location
versionstring-Version of the current modelhttp://a.ml/vocabularies/document#version
references[BaseUnit]falsereferences across base unitshttp://a.ml/vocabularies/document#references
usagestring-Human readable description of the unithttp://a.ml/vocabularies/document#usage
describedByurl-Link to the AML dialect describing a particular subgraph of informationhttp://a.ml/vocabularies/meta#describedBy
rootboolean-Indicates if the base unit represents the root of the document model obtained from parsinghttp://a.ml/vocabularies/document#root
packagestring-Logical identifier providing a common namespace for the information in this base unithttp://a.ml/vocabularies/document#package
processingDataBaseUnitProcessingData-Field with utility data to be used in Base Unit processinghttp://a.ml/vocabularies/document#processingData
sourceInformationBaseUnitSourceInformation-Contains information of the source from which the base unit was generatedhttp://a.ml/vocabularies/document#sourceInformation

VocabularyReference

Types:

  • http://a.ml/vocabularies/meta#VocabularyReference
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
aliasstring-http://a.ml/vocabularies/document#alias
referencestring-http://a.ml/vocabularies/document#reference
basestring-http://a.ml/vocabularies/meta#base
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

WebApi

Top level element describing a HTTP API Types:

  • http://a.ml/vocabularies/apiContract#WebAPI
  • http://a.ml/vocabularies/apiContract#API
  • http://a.ml/vocabularies/document#RootDomainElement
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
namestring-Name of the shapehttp://a.ml/vocabularies/core#name
descriptionstring-Human readable description of an elementhttp://a.ml/vocabularies/core#description
identifierstring-The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc.http://a.ml/vocabularies/core#identifier
server[Server]falseServer informationhttp://a.ml/vocabularies/apiContract#server
accepts[string]falseMedia-types accepted in a API requesthttp://a.ml/vocabularies/apiContract#accepts
contentType[string]falseMedia types returned by a API responsehttp://a.ml/vocabularies/apiContract#contentType
scheme[string]falseURI scheme for the API protocolhttp://a.ml/vocabularies/apiContract#scheme
versionstring-Version of the APIhttp://a.ml/vocabularies/core#version
termsOfServicestring-Terms and conditions when using the APIhttp://a.ml/vocabularies/core#termsOfService
providerOrganization-Organization providing some kind of asset or servicehttp://a.ml/vocabularies/core#provider
licenseLicense-License for the APIhttp://a.ml/vocabularies/core#license
documentation[CreativeWork]falseDocumentation associated to the APIhttp://a.ml/vocabularies/core#documentation
endpoint[EndPoint]falseEnd points defined in the APIhttp://a.ml/vocabularies/apiContract#endpoint
webhooks[EndPoint]falseWebhooks defined in the APIhttp://a.ml/vocabularies/apiContract#webhooks
security[SecurityRequirement]falseTextual indication of the kind of security scheme usedhttp://a.ml/vocabularies/security#security
tag[Tag]falseAdditionally custom tagged informationhttp://a.ml/vocabularies/apiContract#tag
defaultSchemastring-The default value for the $schema keyword within Schema Objectshttp://a.ml/vocabularies/apiContract#defaultSchema
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

WebSocketsChannelBinding

Types:

  • http://a.ml/vocabularies/apiBinding#WebSocketsChannelBinding
  • http://a.ml/vocabularies/apiBinding#ChannelBinding
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
methodstring-The HTTP method to use when establishing the connectionhttp://a.ml/vocabularies/apiBinding#method
queryShape-A Schema object containing the definitions for each query parameterhttp://a.ml/vocabularies/apiBinding#query
headersShape-A Schema object containing the definitions for HTTP-specific headershttp://a.ml/vocabularies/apiBinding#headers
bindingVersionstring-The version of this bindinghttp://a.ml/vocabularies/apiBinding#bindingVersion
typestring-Binding for a corresponding known typehttp://a.ml/vocabularies/apiBinding#type
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends

XMLSerializer

Information about how to encode into XML a particular data shape Types:

  • http://a.ml/vocabularies/shapes#XMLSerializer
  • http://a.ml/vocabularies/document#DomainElement
NameValueSortedDocumentationNamespace
xmlAttributeboolean-XML attribute mappinghttp://a.ml/vocabularies/shapes#xmlAttribute
xmlWrappedboolean-XML wrapped mapping flaghttp://a.ml/vocabularies/shapes#xmlWrapped
xmlNamestring-XML name mappinghttp://a.ml/vocabularies/shapes#xmlName
xmlNamespacestring-XML namespace mappinghttp://a.ml/vocabularies/shapes#xmlNamespace
xmlPrefixstring-XML prefix mappinghttp://a.ml/vocabularies/shapes#xmlPrefix
extends[DomainElement]falseEntity that is going to be extended overlaying or adding additional information The type of the relationship provide the semantics about thow the referenced and referencer elements must be combined when generating the domain model from the document model.http://a.ml/vocabularies/document#extends