AMF Model Documentation --- ## Table of Contents * [APIContractProcessingData](#apicontractprocessingdata) * [AbstractDeclaration](#abstractdeclaration) * [AbstractOperation](#abstractoperation) * [AbstractParameter](#abstractparameter) * [AbstractPayload](#abstractpayload) * [AbstractRequest](#abstractrequest) * [AbstractResponse](#abstractresponse) * [Amqp091ChannelBinding](#amqp091channelbinding) * [Amqp091ChannelBinding010](#amqp091channelbinding010) * [Amqp091ChannelBinding020](#amqp091channelbinding020) * [Amqp091ChannelExchange](#amqp091channelexchange) * [Amqp091ChannelExchange010](#amqp091channelexchange010) * [Amqp091ChannelExchange020](#amqp091channelexchange020) * [Amqp091MessageBinding](#amqp091messagebinding) * [Amqp091OperationBinding](#amqp091operationbinding) * [Amqp091OperationBinding010](#amqp091operationbinding010) * [Amqp091OperationBinding030](#amqp091operationbinding030) * [Amqp091Queue](#amqp091queue) * [Amqp091Queue010](#amqp091queue010) * [Amqp091Queue020](#amqp091queue020) * [AnnotationMapping](#annotationmapping) * [AnnotationTypeDeclarationFragment](#annotationtypedeclarationfragment) * [AnyMapping](#anymapping) * [AnyShape](#anyshape) * [AnypointMQChannelBinding](#anypointmqchannelbinding) * [AnypointMQMessageBinding](#anypointmqmessagebinding) * [ApiKeySettings](#apikeysettings) * [ArrayNode](#arraynode) * [ArrayShape](#arrayshape) * [AsyncApi](#asyncapi) * [AvroSchemaDocument](#avroschemadocument) * [BaseApi](#baseapi) * [BaseIRI](#baseiri) * [BaseUnit](#baseunit) * [BaseUnitProcessingData](#baseunitprocessingdata) * [BaseUnitSourceInformation](#baseunitsourceinformation) * [Callback](#callback) * [ChannelBinding](#channelbinding) * [ChannelBindings](#channelbindings) * [ClassTerm](#classterm) * [ComponentModule](#componentmodule) * [ContextMapping](#contextmapping) * [CorrelationId](#correlationid) * [CreativeWork](#creativework) * [CuriePrefix](#curieprefix) * [CustomDomainProperty](#customdomainproperty) * [DataNode](#datanode) * [DataTypeFragment](#datatypefragment) * [DatatypePropertyTerm](#datatypepropertyterm) * [DefaultVocabulary](#defaultvocabulary) * [Dialect](#dialect) * [DialectFragment](#dialectfragment) * [DialectInstance](#dialectinstance) * [DialectInstanceFragment](#dialectinstancefragment) * [DialectInstanceLibrary](#dialectinstancelibrary) * [DialectInstancePatch](#dialectinstancepatch) * [DialectInstanceProcessingData](#dialectinstanceprocessingdata) * [DialectLibrary](#dialectlibrary) * [DiscriminatorValueMapping](#discriminatorvaluemapping) * [Document](#document) * [DocumentMapping](#documentmapping) * [DocumentationItemFragment](#documentationitemfragment) * [Documents](#documents) * [DomainElement](#domainelement) * [DomainExtension](#domainextension) * [EmptyBinding](#emptybinding) * [Encoding](#encoding) * [EndPoint](#endpoint) * [EndpointFederationMetadata](#endpointfederationmetadata) * [Example](#example) * [Extension](#extension) * [ExtensionLike](#extensionlike) * [External](#external) * [ExternalContextFields](#externalcontextfields) * [ExternalDomainElement](#externaldomainelement) * [ExternalFragment](#externalfragment) * [ExternalPropertyShape](#externalpropertyshape) * [ExternalSourceElement](#externalsourceelement) * [FederationMetadata](#federationmetadata) * [FileShape](#fileshape) * [Fragment](#fragment) * [GooglePubSubChannelBinding](#googlepubsubchannelbinding) * [GooglePubSubChannelBinding010](#googlepubsubchannelbinding010) * [GooglePubSubChannelBinding020](#googlepubsubchannelbinding020) * [GooglePubSubMessageBinding](#googlepubsubmessagebinding) * [GooglePubSubMessageBinding010](#googlepubsubmessagebinding010) * [GooglePubSubMessageBinding020](#googlepubsubmessagebinding020) * [GooglePubSubMessageStoragePolicy](#googlepubsubmessagestoragepolicy) * [GooglePubSubSchemaDefinition](#googlepubsubschemadefinition) * [GooglePubSubSchemaDefinition010](#googlepubsubschemadefinition010) * [GooglePubSubSchemaDefinition020](#googlepubsubschemadefinition020) * [GooglePubSubSchemaSettings](#googlepubsubschemasettings) * [HttpApiKeySettings](#httpapikeysettings) * [HttpMessageBinding](#httpmessagebinding) * [HttpMessageBinding020](#httpmessagebinding020) * [HttpMessageBinding030](#httpmessagebinding030) * [HttpOperationBinding](#httpoperationbinding) * [HttpOperationBinding010](#httpoperationbinding010) * [HttpOperationBinding020](#httpoperationbinding020) * [HttpSettings](#httpsettings) * [IBMMQChannelBinding](#ibmmqchannelbinding) * [IBMMQChannelQueue](#ibmmqchannelqueue) * [IBMMQChannelTopic](#ibmmqchanneltopic) * [IBMMQMessageBinding](#ibmmqmessagebinding) * [IBMMQServerBinding](#ibmmqserverbinding) * [IriTemplateMapping](#iritemplatemapping) * [JsonLDElement](#jsonldelement) * [JsonLDInstanceDocument](#jsonldinstancedocument) * [JsonSchemaDocument](#jsonschemadocument) * [KafkaChannelBinding](#kafkachannelbinding) * [KafkaChannelBinding030](#kafkachannelbinding030) * [KafkaChannelBinding040](#kafkachannelbinding040) * [KafkaChannelBinding050](#kafkachannelbinding050) * [KafkaMessageBinding](#kafkamessagebinding) * [KafkaMessageBinding010](#kafkamessagebinding010) * [KafkaMessageBinding030](#kafkamessagebinding030) * [KafkaOperationBinding](#kafkaoperationbinding) * [KafkaServerBinding](#kafkaserverbinding) * [KafkaTopicConfiguration](#kafkatopicconfiguration) * [KafkaTopicConfiguration040](#kafkatopicconfiguration040) * [KafkaTopicConfiguration050](#kafkatopicconfiguration050) * [Key](#key) * [License](#license) * [LinkNode](#linknode) * [LinkableElement](#linkableelement) * [LocationInformation](#locationinformation) * [MatrixShape](#matrixshape) * [Message](#message) * [MessageBinding](#messagebinding) * [MessageBindings](#messagebindings) * [Module](#module) * [MqttMessageBinding](#mqttmessagebinding) * [MqttMessageBinding010](#mqttmessagebinding010) * [MqttMessageBinding020](#mqttmessagebinding020) * [MqttOperationBinding](#mqttoperationbinding) * [MqttOperationBinding010](#mqttoperationbinding010) * [MqttOperationBinding020](#mqttoperationbinding020) * [MqttServerBinding](#mqttserverbinding) * [MqttServerBinding010](#mqttserverbinding010) * [MqttServerBinding020](#mqttserverbinding020) * [MqttServerLastWill](#mqttserverlastwill) * [MutualTLSSettings](#mutualtlssettings) * [NamedExampleFragment](#namedexamplefragment) * [NilShape](#nilshape) * [NodeMapping](#nodemapping) * [NodeShape](#nodeshape) * [OAuth1Settings](#oauth1settings) * [OAuth2Flow](#oauth2flow) * [OAuth2Settings](#oauth2settings) * [ObjType](#objtype) * [ObjectNode](#objectnode) * [ObjectPropertyTerm](#objectpropertyterm) * [OpenIdConnectSettings](#openidconnectsettings) * [Operation](#operation) * [OperationBinding](#operationbinding) * [OperationBindings](#operationbindings) * [OperationFederationMetadata](#operationfederationmetadata) * [Organization](#organization) * [Overlay](#overlay) * [Parameter](#parameter) * [ParameterFederationMetadata](#parameterfederationmetadata) * [ParameterKeyMapping](#parameterkeymapping) * [ParametrizedDeclaration](#parametrizeddeclaration) * [ParametrizedResourceType](#parametrizedresourcetype) * [ParametrizedSecurityScheme](#parametrizedsecurityscheme) * [ParametrizedTrait](#parametrizedtrait) * [Payload](#payload) * [PayloadFragment](#payloadfragment) * [PropertyDependencies](#propertydependencies) * [PropertyKeyMapping](#propertykeymapping) * [PropertyMapping](#propertymapping) * [PropertyShape](#propertyshape) * [PropertyShapePath](#propertyshapepath) * [PublicNodeMapping](#publicnodemapping) * [PulsarChannelBinding](#pulsarchannelbinding) * [PulsarChannelRetention](#pulsarchannelretention) * [PulsarServerBinding](#pulsarserverbinding) * [RecursiveShape](#recursiveshape) * [Request](#request) * [ResourceType](#resourcetype) * [ResourceTypeFragment](#resourcetypefragment) * [Response](#response) * [ScalarNode](#scalarnode) * [ScalarShape](#scalarshape) * [SchemaDependencies](#schemadependencies) * [SchemaShape](#schemashape) * [Scope](#scope) * [SecurityRequirement](#securityrequirement) * [SecurityScheme](#securityscheme) * [SecuritySchemeFragment](#securityschemefragment) * [SemanticContext](#semanticcontext) * [SemanticExtension](#semanticextension) * [Server](#server) * [ServerBinding](#serverbinding) * [ServerBindings](#serverbindings) * [Settings](#settings) * [Shape](#shape) * [ShapeExtension](#shapeextension) * [ShapeFederationMetadata](#shapefederationmetadata) * [ShapeOperation](#shapeoperation) * [ShapeParameter](#shapeparameter) * [ShapePayload](#shapepayload) * [ShapeRequest](#shaperequest) * [ShapeResponse](#shaperesponse) * [SolaceOperationBinding](#solaceoperationbinding) * [SolaceOperationBinding010](#solaceoperationbinding010) * [SolaceOperationBinding020](#solaceoperationbinding020) * [SolaceOperationBinding030](#solaceoperationbinding030) * [SolaceOperationBinding040](#solaceoperationbinding040) * [SolaceOperationDestination](#solaceoperationdestination) * [SolaceOperationDestination010](#solaceoperationdestination010) * [SolaceOperationDestination020](#solaceoperationdestination020) * [SolaceOperationDestination030](#solaceoperationdestination030) * [SolaceOperationDestination040](#solaceoperationdestination040) * [SolaceOperationQueue](#solaceoperationqueue) * [SolaceOperationQueue010](#solaceoperationqueue010) * [SolaceOperationQueue030](#solaceoperationqueue030) * [SolaceOperationTopic](#solaceoperationtopic) * [SolaceServerBinding](#solaceserverbinding) * [SolaceServerBinding010](#solaceserverbinding010) * [SolaceServerBinding040](#solaceserverbinding040) * [SourceMap](#sourcemap) * [Tag](#tag) * [TemplatedLink](#templatedlink) * [Trait](#trait) * [TraitFragment](#traitfragment) * [TupleShape](#tupleshape) * [UnionNodeMapping](#unionnodemapping) * [UnionShape](#unionshape) * [VariableValue](#variablevalue) * [Vocabulary](#vocabulary) * [VocabularyReference](#vocabularyreference) * [WebApi](#webapi) * [WebSocketsChannelBinding](#websocketschannelbinding) * [XMLSerializer](#xmlserializer) ## APIContractProcessingData Class that groups data related to how a Base Unit was processed Types: * `http://a.ml/vocabularies/document#APIContractProcessingData` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | modelVersion | string | - | Version of the API contract model | `http://a.ml/vocabularies/apiContract#modelVersion` | | transformed | boolean | - | Indicates whether a BaseUnit was transformed with some pipeline | `http://a.ml/vocabularies/document#transformed` | | sourceSpec | string | - | Standard of the specification file | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | dataNode | [DataNode](#datanode) | - | Associated dynamic structure for the declaration | `http://a.ml/vocabularies/document#dataNode` | | variable | [string] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | expects | [[AbstractRequest](#abstractrequest)] | false | Request information required by the operation | `http://a.ml/vocabularies/core#expects` | | returns | [[AbstractResponse](#abstractresponse)] | false | Response data returned by the operation | `http://a.ml/vocabularies/core#returns` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | paramName | string | - | Name of a parameter | `http://a.ml/vocabularies/core#paramName` | | binding | string | - | Part of the Request model where the parameter can be encoded (header, path, query param, etc.) | `http://a.ml/vocabularies/core#binding` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | required | boolean | - | Marks the parameter as required | `http://a.ml/vocabularies/core#required` | | schema | [Shape](#shape) | - | Schema the parameter value must validate | `http://a.ml/vocabularies/shapes#schema` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a parameter | `http://a.ml/vocabularies/core#defaultValue` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | schema | [Shape](#shape) | - | Schema associated to this payload | `http://a.ml/vocabularies/shapes#schema` | | mediaType | string | - | Media types supported in the payload | `http://a.ml/vocabularies/core#mediaType` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | ## AbstractRequest Request information for an operation Types: * `http://a.ml/vocabularies/core#Request` * `http://a.ml/vocabularies/document#DomainElement` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | parameter | [[AbstractParameter](#abstractparameter)] | false | Parameters associated to the communication model | `http://a.ml/vocabularies/core#parameter` | ## AbstractResponse Response information for an operation Types: * `http://a.ml/vocabularies/core#Response` * `http://a.ml/vocabularies/document#DomainElement` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | payload | [AbstractPayload](#abstractpayload) | - | Payload for a Request/Response | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | is | string | - | Defines what type of channel is it | `http://a.ml/vocabularies/apiBinding#is` | | exchange | [Amqp091ChannelExchange](#amqp091channelexchange) | - | Defines the exchange properties | `http://a.ml/vocabularies/apiBinding#exchange` | | queue | [Amqp091Queue](#amqp091queue) | - | Defines the queue properties | `http://a.ml/vocabularies/apiBinding#queue` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | is | string | - | Defines what type of channel is it | `http://a.ml/vocabularies/apiBinding#is` | | exchange | [Amqp091ChannelExchange010](#amqp091channelexchange010) | - | Defines the exchange properties | `http://a.ml/vocabularies/apiBinding#exchange` | | queue | [Amqp091Queue010](#amqp091queue010) | - | Defines the queue properties | `http://a.ml/vocabularies/apiBinding#queue` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | is | string | - | Defines what type of channel is it | `http://a.ml/vocabularies/apiBinding#is` | | exchange | [Amqp091ChannelExchange020](#amqp091channelexchange020) | - | Defines the exchange properties | `http://a.ml/vocabularies/apiBinding#exchange` | | queue | [Amqp091Queue020](#amqp091queue020) | - | Defines the queue properties | `http://a.ml/vocabularies/apiBinding#queue` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | type | string | - | The type of the exchange | `http://a.ml/vocabularies/apiBinding#type` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | type | string | - | The type of the exchange | `http://a.ml/vocabularies/apiBinding#type` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | type | string | - | The type of the exchange | `http://a.ml/vocabularies/apiBinding#type` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | vhost | string | - | The virtual host of the exchange | `http://a.ml/vocabularies/apiBinding#vhost` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | contentEncoding | string | - | MIME encoding for the message content | `http://a.ml/vocabularies/apiBinding#contentEncoding` | | messageType | string | - | Application-specific message type | `http://a.ml/vocabularies/apiBinding#messageType` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | expiration | int | - | TTL (Time-To-Live) for the message | `http://a.ml/vocabularies/apiBinding#expiration` | | userId | string | - | Identifies the user who has sent the message | `http://a.ml/vocabularies/apiBinding#userId` | | cc | [string] | false | The routing keys the message should be routed to at the time of publishing | `http://a.ml/vocabularies/apiBinding#cc` | | priority | int | - | A priority for the message | `http://a.ml/vocabularies/apiBinding#priority` | | deliveryMode | int | - | Delivery mode of the message | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | mandatory | boolean | - | Whether the message is mandatory or not | `http://a.ml/vocabularies/apiBinding#mandatory` | | bcc | [string] | false | Like cc but consumers will not receive this information | `http://a.ml/vocabularies/apiBinding#bcc` | | timestamp | boolean | - | Whether the message should include a timestamp or not | `http://a.ml/vocabularies/apiBinding#timestamp` | | ack | boolean | - | Whether the consumer should ack the message or not | `http://a.ml/vocabularies/apiBinding#ack` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | expiration | int | - | TTL (Time-To-Live) for the message | `http://a.ml/vocabularies/apiBinding#expiration` | | userId | string | - | Identifies the user who has sent the message | `http://a.ml/vocabularies/apiBinding#userId` | | cc | [string] | false | The routing keys the message should be routed to at the time of publishing | `http://a.ml/vocabularies/apiBinding#cc` | | priority | int | - | A priority for the message | `http://a.ml/vocabularies/apiBinding#priority` | | deliveryMode | int | - | Delivery mode of the message | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | mandatory | boolean | - | Whether the message is mandatory or not | `http://a.ml/vocabularies/apiBinding#mandatory` | | bcc | [string] | false | Like cc but consumers will not receive this information | `http://a.ml/vocabularies/apiBinding#bcc` | | replyTo | string | - | Name of the queue where the consumer should send the response | `http://a.ml/vocabularies/apiBinding#replyTo` | | timestamp | boolean | - | Whether the message should include a timestamp or not | `http://a.ml/vocabularies/apiBinding#timestamp` | | ack | boolean | - | Whether the consumer should ack the message or not | `http://a.ml/vocabularies/apiBinding#ack` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | expiration | int | - | TTL (Time-To-Live) for the message | `http://a.ml/vocabularies/apiBinding#expiration` | | userId | string | - | Identifies the user who has sent the message | `http://a.ml/vocabularies/apiBinding#userId` | | cc | [string] | false | The routing keys the message should be routed to at the time of publishing | `http://a.ml/vocabularies/apiBinding#cc` | | priority | int | - | A priority for the message | `http://a.ml/vocabularies/apiBinding#priority` | | deliveryMode | int | - | Delivery mode of the message | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | mandatory | boolean | - | Whether the message is mandatory or not | `http://a.ml/vocabularies/apiBinding#mandatory` | | bcc | [string] | false | Like cc but consumers will not receive this information | `http://a.ml/vocabularies/apiBinding#bcc` | | timestamp | boolean | - | Whether the message should include a timestamp or not | `http://a.ml/vocabularies/apiBinding#timestamp` | | ack | boolean | - | Whether the consumer should ack the message or not | `http://a.ml/vocabularies/apiBinding#ack` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | exclusive | boolean | - | Whether the queue should be used only by one connection or not | `http://a.ml/vocabularies/apiBinding#exclusive` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | exclusive | boolean | - | Whether the queue should be used only by one connection or not | `http://a.ml/vocabularies/apiBinding#exclusive` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | durable | boolean | - | Whether the exchange should survive broker restarts or not | `http://a.ml/vocabularies/apiBinding#durable` | | exclusive | boolean | - | Whether the queue should be used only by one connection or not | `http://a.ml/vocabularies/apiBinding#exclusive` | | autoDelete | boolean | - | Whether the exchange should be deleted when the last queue is unbound from it | `http://a.ml/vocabularies/apiBinding#autoDelete` | | vhost | string | - | The virtual host of the exchange | `http://a.ml/vocabularies/apiBinding#vhost` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | path | url | - | URI for the mapped graph property derived from this mapping | `http://www.w3.org/ns/shacl#path` | | name | string | - | Name of the node mappable element | `http://a.ml/vocabularies/core#name` | | datatype | url | - | Scalar constraint over the type of the mapped graph property | `http://www.w3.org/ns/shacl#datatype` | | node | [url] | true | Object constraint over the type of the mapped graph property | `http://www.w3.org/ns/shacl#node` | | minCount | int | - | Minimum count constraint over the mapped property | `http://www.w3.org/ns/shacl#minCount` | | pattern | string | - | Pattern constraint over the mapped property | `http://www.w3.org/ns/shacl#pattern` | | minInclusive | double | - | Minimum inclusive constraint over the mapped property | `http://www.w3.org/ns/shacl#minInclusive` | | maxInclusive | double | - | Maximum inclusive constraint over the mapped property | `http://www.w3.org/ns/shacl#maxInclusive` | | allowMultiple | boolean | - | Allows multiple mapped nodes for the property mapping | `http://a.ml/vocabularies/meta#allowMultiple` | | sorted | boolean | - | Marks the mapping as requiring order in the mapped collection of nodes | `http://a.ml/vocabularies/meta#sorted` | | in | [Any] | true | Enum constraint for the values of the property mapping | `http://www.w3.org/ns/shacl#in` | | typeDiscriminatorMap | string | - | Information about the discriminator values in the source AST for the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorMap` | | unique | boolean | - | Marks the values for the property mapping as a primary key for this type of node | `http://a.ml/vocabularies/meta#unique` | | externallyLinkable | boolean | - | Marks this object property as supporting external links | `http://a.ml/vocabularies/meta#externallyLinkable` | | typeDiscriminatorName | string | - | Information about the field in the source AST to be used as discrimintaro in the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorName` | | mapProperty | string | - | Marks the mapping as a 'map' mapping syntax. Directly related with mapTermKeyProperty | `http://a.ml/vocabularies/meta#mapProperty` | | mapValueProperty | string | - | Marks the mapping as a 'map value' mapping syntax. Directly related with mapTermValueProperty | `http://a.ml/vocabularies/meta#mapValueProperty` | | mapTermProperty | url | - | Marks the mapping as a 'map' mapping syntax. | `http://a.ml/vocabularies/meta#mapTermProperty` | | mapTermValueProperty | url | - | Marks the mapping as a 'map value' mapping syntax | `http://a.ml/vocabularies/meta#mapTermValueProperty` | | domain | [url] | false | Domain 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](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | and | [url] | false | Logical and composition of data | `http://a.ml/vocabularies/amf/aml#and` | | or | [url] | false | Logical or composition of data | `http://a.ml/vocabularies/amf/aml#or` | | components | [url] | false | Array of component mappings in case of component combination generated mapping | `http://a.ml/vocabularies/amf/aml#components` | | if | url | - | Conditional constraint if over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#if` | | then | url | - | Conditional constraint then over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#then` | | else | url | - | Conditional constraint else over the type of the mapped graph property | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destination | string | - | The destination (queue or exchange) name for this channel. | `http://a.ml/vocabularies/apiBinding#destination` | | destinationType | string | - | The type of destination (either exchange or queue or fifo-queue). | `http://a.ml/vocabularies/apiBinding#destinationType` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | headers | [Shape](#shape) | - | A Schema object containing the definitions for HTTP-specific headers | `http://a.ml/vocabularies/apiBinding#headers` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | | `http://a.ml/vocabularies/core#name` | | in | string | - | | `http://a.ml/vocabularies/security#in` | | scope | [[Scope](#scope)] | false | | `http://a.ml/vocabularies/security#scope` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | member | [[DataNode](#datanode)] | false | | `http://www.w3.org/2000/01/rdf-schema#member` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | items | [Shape](#shape) | - | Shapes inside the data arrangement | `http://a.ml/vocabularies/shapes#items` | | contains | [Shape](#shape) | - | One of the shapes in the data arrangement | `http://a.ml/vocabularies/shapes#contains` | | minCount | int | - | Minimum items count constraint | `http://www.w3.org/ns/shacl#minCount` | | maxCount | int | - | Maximum items count constraint | `http://www.w3.org/ns/shacl#maxCount` | | uniqueItems | boolean | - | Unique items constraint | `http://a.ml/vocabularies/shapes#uniqueItems` | | collectionFormat | string | - | Input collection format information | `http://a.ml/vocabularies/shapes#collectionFormat` | | unevaluatedItems | boolean | - | Accepts that items may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedItems` | | unevaluatedItemsSchema | [Shape](#shape) | - | Items that may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedItemsSchema` | | qualifiedMinCount | int | - | Minimum number of value nodes constraint | `http://www.w3.org/ns/shacl#qualifiedMinCount` | | qualifiedMaxCount | int | - | Maximum number of value nodes constraint | `http://www.w3.org/ns/shacl#qualifiedMaxCount` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | identifier | string | - | The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc. | `http://a.ml/vocabularies/core#identifier` | | server | [[Server](#server)] | false | Server information | `http://a.ml/vocabularies/apiContract#server` | | accepts | [string] | false | Media-types accepted in a API request | `http://a.ml/vocabularies/apiContract#accepts` | | contentType | [string] | false | Media types returned by a API response | `http://a.ml/vocabularies/apiContract#contentType` | | scheme | [string] | false | URI scheme for the API protocol | `http://a.ml/vocabularies/apiContract#scheme` | | version | string | - | Version of the API | `http://a.ml/vocabularies/core#version` | | termsOfService | string | - | Terms and conditions when using the API | `http://a.ml/vocabularies/core#termsOfService` | | provider | [Organization](#organization) | - | Organization providing some kind of asset or service | `http://a.ml/vocabularies/core#provider` | | license | [License](#license) | - | License for the API | `http://a.ml/vocabularies/core#license` | | documentation | [[CreativeWork](#creativework)] | false | Documentation associated to the API | `http://a.ml/vocabularies/core#documentation` | | endpoint | [[EndPoint](#endpoint)] | false | End points defined in the API | `http://a.ml/vocabularies/apiContract#endpoint` | | webhooks | [[EndPoint](#endpoint)] | false | Webhooks defined in the API | `http://a.ml/vocabularies/apiContract#webhooks` | | security | [[SecurityRequirement](#securityrequirement)] | false | Textual indication of the kind of security scheme used | `http://a.ml/vocabularies/security#security` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | defaultSchema | string | - | The default value for the $schema keyword within Schema Objects | `http://a.ml/vocabularies/apiContract#defaultSchema` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | identifier | string | - | The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc. | `http://a.ml/vocabularies/core#identifier` | | server | [[Server](#server)] | false | Server information | `http://a.ml/vocabularies/apiContract#server` | | accepts | [string] | false | Media-types accepted in a API request | `http://a.ml/vocabularies/apiContract#accepts` | | contentType | [string] | false | Media types returned by a API response | `http://a.ml/vocabularies/apiContract#contentType` | | scheme | [string] | false | URI scheme for the API protocol | `http://a.ml/vocabularies/apiContract#scheme` | | version | string | - | Version of the API | `http://a.ml/vocabularies/core#version` | | termsOfService | string | - | Terms and conditions when using the API | `http://a.ml/vocabularies/core#termsOfService` | | provider | [Organization](#organization) | - | Organization providing some kind of asset or service | `http://a.ml/vocabularies/core#provider` | | license | [License](#license) | - | License for the API | `http://a.ml/vocabularies/core#license` | | documentation | [[CreativeWork](#creativework)] | false | Documentation associated to the API | `http://a.ml/vocabularies/core#documentation` | | endpoint | [[EndPoint](#endpoint)] | false | End points defined in the API | `http://a.ml/vocabularies/apiContract#endpoint` | | webhooks | [[EndPoint](#endpoint)] | false | Webhooks defined in the API | `http://a.ml/vocabularies/apiContract#webhooks` | | security | [[SecurityRequirement](#securityrequirement)] | false | Textual indication of the kind of security scheme used | `http://a.ml/vocabularies/security#security` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | defaultSchema | string | - | The default value for the $schema keyword within Schema Objects | `http://a.ml/vocabularies/apiContract#defaultSchema` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | iri | url | - | Base IRI for all the elements in the model | `http://a.ml/vocabularies/meta#iri` | | nulled | boolean | - | Marks the baseIRI as null, preventing generation of absolute IRIs in the model | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | transformed | boolean | - | Indicates whether a BaseUnit was transformed with some pipeline | `http://a.ml/vocabularies/document#transformed` | | sourceSpec | string | - | Standard of the specification file | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | rootLocation | string | - | Root source location of base unit | `http://a.ml/vocabularies/document#rootLocation` | | additionalLocations | [[LocationInformation](#locationinformation)] | false | Additional source locations from which certain elements where parsed | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | expression | string | - | Structural location of the information to fulfill the callback | `http://a.ml/vocabularies/apiContract#expression` | | endpoint | [EndPoint](#endpoint) | - | Endpoint targeted by the callback | `http://a.ml/vocabularies/apiContract#endpoint` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | bindings | [[ChannelBinding](#channelbinding)] | false | List of channel bindings | `http://a.ml/vocabularies/apiBinding#bindings` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the ClassTerm | `http://a.ml/vocabularies/core#name` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | description | string | - | Human readable description for the term | `http://a.ml/vocabularies/core#description` | | properties | [url] | false | Properties that have the ClassTerm in the domain | `http://a.ml/vocabularies/meta#properties` | | subClassOf | [url] | false | Subsumption relationship across terms | `http://www.w3.org/2000/01/rdf-schema#subClassOf` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | declares | [[DomainElement](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://a.ml/vocabularies/document#sourceInformation` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | version | string | - | Version of the API | `http://a.ml/vocabularies/core#version` | ## ContextMapping Stores information about mapping rules for a property in the model Types: * `http://a.ml/vocabularies/meta#ContextMapping` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | contextAlias | string | - | lexical value of the alias in the context | `http://a.ml/vocabularies/meta#contextAlias` | | iri | url | - | Base IRI for all the elements in the model | `http://a.ml/vocabularies/meta#iri` | | coercion | string | - | Type to coerce the mapped model | `http://a.ml/vocabularies/meta#coercion` | | nulled | boolean | - | Marks the baseIRI as null, preventing generation of absolute IRIs in the model | `http://a.ml/vocabularies/meta#nulled` | | containers | [string] | false | Sets the default containers types for a term | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | location | string | - | Structural location of a piece of information | `http://a.ml/vocabularies/core#location` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | url | url | - | URL for the creative work | `http://a.ml/vocabularies/core#url` | | title | string | - | Title of the item | `http://a.ml/vocabularies/core#title` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | ## CuriePrefix Stores information about a CURIE prefix defined in the context Types: * `http://a.ml/vocabularies/meta#ContextCuriePrefix` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | contextAlias | string | - | lexical value of the alias in the context | `http://a.ml/vocabularies/meta#contextAlias` | | iri | url | - | Base IRI for all the elements in the model | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | domain | [url] | false | RDFS domain property | `http://www.w3.org/2000/01/rdf-schema#domain` | | schema | [Shape](#shape) | - | Schema for an entity | `http://a.ml/vocabularies/shapes#schema` | | name | string | - | Name for an entity | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | serializationOrder | int | - | position in the set of properties for a shape used to serialize this property on the wire | `http://a.ml/vocabularies/shapes#serializationOrder` | | repeatable | boolean | - | Indicates if a Domain Element can define more than 1 Domain Extension defined by this Custom Domain Property | `http://a.ml/vocabularies/core#repeatable` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | displayName | string | - | Human readable name for the property term | `http://a.ml/vocabularies/core#displayName` | | description | string | - | Human readable description of the property term | `http://a.ml/vocabularies/core#description` | | range | url | - | Range of the proeprty term, scalar or object | `http://www.w3.org/2000/01/rdf-schema#range` | | subPropertyOf | [url] | false | Subsumption relationship for terms | `http://www.w3.org/2000/01/rdf-schema#subPropertyOf` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | iri | url | - | Base IRI for all the elements in the model | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the dialect | `http://a.ml/vocabularies/core#name` | | version | string | - | Version of the dialect | `http://a.ml/vocabularies/core#version` | | extensions | [[SemanticExtension](#semanticextension)] | false | Extensions mappings derived from annotation mappings declarations in a dialect | `http://a.ml/vocabularies/meta#extensions` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | documents | [Documents](#documents) | - | Document mapping for the the dialect | `http://a.ml/vocabularies/meta#documents` | | location | string | - | Location of the metadata document that generated this base unit | `http://a.ml/vocabularies/document#location` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | location | string | - | Location of the metadata document that generated this base unit | `http://a.ml/vocabularies/document#location` | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | url | - | | `http://a.ml/vocabularies/meta#definedBy` | | graphDependencies | [url] | false | | `http://a.ml/vocabularies/document#graphDependencies` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | url | - | | `http://a.ml/vocabularies/meta#definedBy` | | fragment | string | - | | `http://a.ml/vocabularies/meta#fragment` | | graphDependencies | [url] | false | | `http://a.ml/vocabularies/document#graphDependencies` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | url | - | | `http://a.ml/vocabularies/meta#definedBy` | | graphDependencies | [url] | false | | `http://a.ml/vocabularies/document#graphDependencies` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | declares | [[DomainElement](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | url | - | | `http://a.ml/vocabularies/meta#definedBy` | | graphDependencies | [url] | false | | `http://a.ml/vocabularies/document#graphDependencies` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | extends | url | - | Target base unit being extended by this extension model | `http://a.ml/vocabularies/document#extends` | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | url | - | Dialect used to parse this Dialect Instance | `http://a.ml/vocabularies/meta#definedBy` | | graphDependencies | [url] | false | Other dialects referenced to parse specific nodes in this Dialect Instance | `http://a.ml/vocabularies/document#graphDependencies` | | transformed | boolean | - | Indicates whether a BaseUnit was transformed with some pipeline | `http://a.ml/vocabularies/document#transformed` | | sourceSpec | string | - | Standard of the specification file | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | location | string | - | Location of the metadata document that generated this base unit | `http://a.ml/vocabularies/document#location` | | declares | [[DomainElement](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | discriminatorValue | string | - | Value given to a discriminator that identifies a target Shape | `http://a.ml/vocabularies/shapes#discriminatorValue` | | discriminatorValueTarget | [Shape](#shape) | - | Target shape for a certain discriminator value | `http://a.ml/vocabularies/shapes#discriminatorValueTarget` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the document for a dialect base unit | `http://a.ml/vocabularies/core#name` | | encodedNode | url | - | Node in the dialect encoded in the target mapped base unit | `http://a.ml/vocabularies/meta#encodedNode` | | declaredNode | [[PublicNodeMapping](#publicnodemapping)] | false | Node in the dialect declared in the target mappend base unit | `http://a.ml/vocabularies/meta#declaredNode` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | rootDocument | [DocumentMapping](#documentmapping) | - | Root node encoded in a mapped document base unit | `http://a.ml/vocabularies/meta#rootDocument` | | fragments | [[DocumentMapping](#documentmapping)] | false | Mapping of fragment base unit for a particular dialect | `http://a.ml/vocabularies/meta#fragments` | | library | [DocumentMapping](#documentmapping) | - | Mappig of module base unit for a particular dialect | `http://a.ml/vocabularies/meta#library` | | selfEncoded | boolean | - | Information about if the base unit URL should be the same as the URI of the parsed root nodes in the unit | `http://a.ml/vocabularies/meta#selfEncoded` | | declarationsPath | string | - | Information about the AST location of the declarations to be parsed as declared domain elements | `http://a.ml/vocabularies/meta#declarationsPath` | | keyProperty | boolean | - | Information about whether the dialect is defined by the header or a key property | `http://a.ml/vocabularies/meta#keyProperty` | | referenceStyle | string | - | Determines the style for inclusions (RamlStyle or JsonSchemaStyle) | `http://a.ml/vocabularies/meta#referenceStyle` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | extensionName | string | - | Name of an extension entity | `http://a.ml/vocabularies/core#extensionName` | | definedBy | [CustomDomainProperty](#customdomainproperty) | - | Definition for the extended entity | `http://a.ml/vocabularies/document#definedBy` | | extension | [DataNode](#datanode) | - | Data structure associated to the extension | `http://a.ml/vocabularies/document#extension` | | element | string | - | Element being extended | `http://a.ml/vocabularies/document#element` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | ## Encoding Types: * `http://a.ml/vocabularies/apiContract#Encoding` * `http://a.ml/vocabularies/document#DomainElement` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | propertyName | string | - | | `http://a.ml/vocabularies/apiContract#propertyName` | | contentType | string | - | | `http://a.ml/vocabularies/apiContract#contentType` | | header | [[Parameter](#parameter)] | false | | `http://a.ml/vocabularies/apiContract#header` | | style | string | - | Describes how a specific property value will be serialized depending on its type. | `http://a.ml/vocabularies/apiContract#style` | | explode | boolean | - | | `http://a.ml/vocabularies/apiContract#explode` | | allowReserved | boolean | - | | `http://a.ml/vocabularies/apiContract#allowReserved` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | path | string | - | Path template for an endpoint | `http://a.ml/vocabularies/apiContract#path` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | summary | string | - | Human readable short description of the endpoint | `http://a.ml/vocabularies/core#summary` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | supportedOperation | [[Operation](#operation)] | false | Operations supported by an endpoint | `http://a.ml/vocabularies/apiContract#supportedOperation` | | parameter | [[Parameter](#parameter)] | false | Additional data required or returned by an operation | `http://a.ml/vocabularies/apiContract#parameter` | | payload | [[Payload](#payload)] | false | Main payload data required or returned by an operation | `http://a.ml/vocabularies/apiContract#payload` | | server | [[Server](#server)] | false | Specific information about the server where the endpoint is accessible | `http://a.ml/vocabularies/apiContract#server` | | security | [[SecurityRequirement](#securityrequirement)] | false | Textual indication of the kind of security scheme used | `http://a.ml/vocabularies/security#security` | | binding | [ChannelBindings](#channelbindings) | - | Bindings for this endpoint | `http://a.ml/vocabularies/apiBinding#binding` | | federationMetadata | [EndpointFederationMetadata](#endpointfederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name element in the federated graph | `http://a.ml/vocabularies/federation#name` | | tags | [string] | false | Federation tags of the element | `http://a.ml/vocabularies/federation#tags` | | shareable | boolean | - | Element can be defined by more than one component of the federated graph | `http://a.ml/vocabularies/federation#shareable` | | inaccessible | boolean | - | Element cannot be accessed by the federated graph | `http://a.ml/vocabularies/federation#inaccessible` | | overrideFrom | string | - | Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argument | `http://a.ml/vocabularies/federation#overrideFrom` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | guiSummary | string | - | Human readable description of the example | `http://a.ml/vocabularies/apiContract#guiSummary` | | description | string | - | | `http://a.ml/vocabularies/core#description` | | externalValue | string | - | Raw text containing an unparsable example | `http://a.ml/vocabularies/document#externalValue` | | strict | boolean | - | Indicates if this example should be validated against an associated schema | `http://a.ml/vocabularies/document#strict` | | mediaType | string | - | Media type associated to the example | `http://a.ml/vocabularies/core#mediaType` | | structuredValue | [DataNode](#datanode) | - | Data structure containing the value of the example | `http://a.ml/vocabularies/document#structuredValue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | extends | url | - | Target base unit being extended by this extension model | `http://a.ml/vocabularies/document#extends` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | extends | url | - | Target base unit being extended by this extension model | `http://a.ml/vocabularies/document#extends` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | displayName | string | - | The display name of the item | `http://a.ml/vocabularies/core#displayName` | | base | string | - | Base URI for the external model | `http://a.ml/vocabularies/meta#base` | | extends | [[DomainElement](#domainelement)] | false | Entity 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: | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | externals | [[External](#external)] | false | | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | mediaType | string | - | Media type associated to the encoded fragment information | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name for an external data shape | `http://www.w3.org/ns/shacl#name` | | keyMappings | [[PropertyKeyMapping](#propertykeymapping)] | false | Mapping from local properties to properties from the external range shape (identified by rangeName) to be used for data retrieval | `http://a.ml/vocabularies/federation#keyMappings` | | rangeName | string | - | Federation name of the External Shape in the external graph | `http://a.ml/vocabularies/federation#rangeName` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name element in the federated graph | `http://a.ml/vocabularies/federation#name` | | tags | [string] | false | Federation tags of the element | `http://a.ml/vocabularies/federation#tags` | | shareable | boolean | - | Element can be defined by more than one component of the federated graph | `http://a.ml/vocabularies/federation#shareable` | | inaccessible | boolean | - | Element cannot be accessed by the federated graph | `http://a.ml/vocabularies/federation#inaccessible` | | overrideFrom | string | - | Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argument | `http://a.ml/vocabularies/federation#overrideFrom` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | fileType | [string] | false | Type of file described by this shape | `http://a.ml/vocabularies/shapes#fileType` | | pattern | string | - | Pattern constraint | `http://www.w3.org/ns/shacl#pattern` | | minLength | int | - | Minimum lenght constraint | `http://www.w3.org/ns/shacl#minLength` | | maxLength | int | - | Maximum length constraint | `http://www.w3.org/ns/shacl#maxLength` | | minInclusive | double | - | Minimum inclusive constraint | `http://www.w3.org/ns/shacl#minInclusive` | | maxInclusive | double | - | Maximum inclusive constraint | `http://www.w3.org/ns/shacl#maxInclusive` | | minExclusive | boolean | - | Minimum exclusive constraint | `http://www.w3.org/ns/shacl#minExclusive` | | maxExclusive | boolean | - | Maximum exclusive constraint | `http://www.w3.org/ns/shacl#maxExclusive` | | exclusiveMinimumNumeric | double | - | Minimum exclusive constraint | `http://a.ml/vocabularies/shapes#exclusiveMinimumNumeric` | | exclusiveMaximumNumeric | double | - | Maximum exclusive constraint | `http://a.ml/vocabularies/shapes#exclusiveMaximumNumeric` | | format | string | - | Format constraint | `http://a.ml/vocabularies/shapes#format` | | multipleOf | double | - | Multiple of constraint | `http://a.ml/vocabularies/shapes#multipleOf` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | labels | [ObjectNode](#objectnode) | - | An object of key-value pairs | `http://a.ml/vocabularies/apiBinding#labels` | | messageRetentionDuration | string | - | Indicates the minimum duration to retain a message after it is published to the topic | `http://a.ml/vocabularies/apiBinding#messageRetentionDuration` | | messageStoragePolicy | [GooglePubSubMessageStoragePolicy](#googlepubsubmessagestoragepolicy) | - | Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored | `http://a.ml/vocabularies/apiBinding#messageStoragePolicy` | | schemaSettings | [GooglePubSubSchemaSettings](#googlepubsubschemasettings) | - | Settings for validating messages published against a schema | `http://a.ml/vocabularies/apiBinding#schemaSettings` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topic | string | - | The Google Cloud Pub/Sub Topic name | `http://a.ml/vocabularies/apiBinding#topic` | | labels | [ObjectNode](#objectnode) | - | An object of key-value pairs | `http://a.ml/vocabularies/apiBinding#labels` | | messageRetentionDuration | string | - | Indicates the minimum duration to retain a message after it is published to the topic | `http://a.ml/vocabularies/apiBinding#messageRetentionDuration` | | messageStoragePolicy | [GooglePubSubMessageStoragePolicy](#googlepubsubmessagestoragepolicy) | - | Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored | `http://a.ml/vocabularies/apiBinding#messageStoragePolicy` | | schemaSettings | [GooglePubSubSchemaSettings](#googlepubsubschemasettings) | - | Settings for validating messages published against a schema | `http://a.ml/vocabularies/apiBinding#schemaSettings` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | labels | [ObjectNode](#objectnode) | - | An object of key-value pairs | `http://a.ml/vocabularies/apiBinding#labels` | | messageRetentionDuration | string | - | Indicates the minimum duration to retain a message after it is published to the topic | `http://a.ml/vocabularies/apiBinding#messageRetentionDuration` | | messageStoragePolicy | [GooglePubSubMessageStoragePolicy](#googlepubsubmessagestoragepolicy) | - | Policy constraining the set of Google Cloud Platform regions where messages published to the topic may be stored | `http://a.ml/vocabularies/apiBinding#messageStoragePolicy` | | schemaSettings | [GooglePubSubSchemaSettings](#googlepubsubschemasettings) | - | Settings for validating messages published against a schema | `http://a.ml/vocabularies/apiBinding#schemaSettings` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | attribute | [ObjectNode](#objectnode) | - | Attributes for this message | `http://a.ml/vocabularies/apiBinding#attribute` | | orderingKey | string | - | If non-empty, identifies related messages for which publish order should be respected | `http://a.ml/vocabularies/apiBinding#orderingKey` | | schemaDefinition | [GooglePubSubSchemaDefinition](#googlepubsubschemadefinition) | - | Define Schema | `http://a.ml/vocabularies/apiBinding#schemaDefinition` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | attribute | [ObjectNode](#objectnode) | - | Attributes for this message | `http://a.ml/vocabularies/apiBinding#attribute` | | orderingKey | string | - | If non-empty, identifies related messages for which publish order should be respected | `http://a.ml/vocabularies/apiBinding#orderingKey` | | schemaDefinition | [GooglePubSubSchemaDefinition010](#googlepubsubschemadefinition010) | - | Define Schema | `http://a.ml/vocabularies/apiBinding#schemaDefinition` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | attribute | [ObjectNode](#objectnode) | - | Attributes for this message | `http://a.ml/vocabularies/apiBinding#attribute` | | orderingKey | string | - | If non-empty, identifies related messages for which publish order should be respected | `http://a.ml/vocabularies/apiBinding#orderingKey` | | schemaDefinition | [GooglePubSubSchemaDefinition020](#googlepubsubschemadefinition020) | - | Define Schema | `http://a.ml/vocabularies/apiBinding#schemaDefinition` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | allowedPersistenceRegions | [string] | false | A list of IDs of GCP regions where messages that are published to the topic may be persisted in storage | `http://a.ml/vocabularies/apiBinding#allowedPersistenceRegions` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | The type of the schema | `http://a.ml/vocabularies/apiBinding#type` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | encoding | string | - | The encoding of the message | `http://a.ml/vocabularies/apiBinding#encoding` | | firstRevisionId | string | - | The minimum (inclusive) revision allowed for validating messages | `http://a.ml/vocabularies/apiBinding#firstRevisionId` | | lastRevisionId | string | - | The maximum (inclusive) revision allowed for validating messages | `http://a.ml/vocabularies/apiBinding#lastRevisionId` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | | `http://a.ml/vocabularies/core#name` | | in | string | - | | `http://a.ml/vocabularies/security#in` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | headers | [Shape](#shape) | - | A Schema object containing the definitions for HTTP-specific headers | `http://a.ml/vocabularies/apiBinding#headers` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | headers | [Shape](#shape) | - | A Schema object containing the definitions for HTTP-specific headers | `http://a.ml/vocabularies/apiBinding#headers` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | statusCode | int | - | The HTTP response status code according to RFC 9110. | `http://a.ml/vocabularies/apiBinding#statusCode` | | headers | [Shape](#shape) | - | A Schema object containing the definitions for HTTP-specific headers | `http://a.ml/vocabularies/apiBinding#headers` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | method | string | - | Operation binding method | `http://a.ml/vocabularies/apiBinding#method` | | query | [Shape](#shape) | - | A Schema object containing the definitions for each query parameter | `http://a.ml/vocabularies/apiBinding#query` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | operationType | string | - | Type of operation | `http://a.ml/vocabularies/apiBinding#operationType` | | method | string | - | Operation binding method | `http://a.ml/vocabularies/apiBinding#method` | | query | [Shape](#shape) | - | A Schema object containing the definitions for each query parameter | `http://a.ml/vocabularies/apiBinding#query` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | method | string | - | Operation binding method | `http://a.ml/vocabularies/apiBinding#method` | | query | [Shape](#shape) | - | A Schema object containing the definitions for each query parameter | `http://a.ml/vocabularies/apiBinding#query` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | scheme | string | - | | `http://a.ml/vocabularies/security#scheme` | | bearerFormat | string | - | | `http://a.ml/vocabularies/security#bearerFormat` | | scope | [[Scope](#scope)] | false | | `http://a.ml/vocabularies/security#scope` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | Defines the type of AsyncAPI channel. | `http://a.ml/vocabularies/apiBinding#destinationType` | | queue | [IBMMQChannelQueue](#ibmmqchannelqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | topic | [IBMMQChannelTopic](#ibmmqchanneltopic) | - | Defines the properties of a topic. | `http://a.ml/vocabularies/apiBinding#topic` | | maxMsgLength | int | - | 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` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | objectName | string | - | Defines the name of the IBM MQ queue associated with the channel. | `http://a.ml/vocabularies/apiBinding#objectName` | | isPartitioned | boolean | - | 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` | | exclusive | boolean | - | Specifies if it is recommended to open the queue exclusively. | `http://a.ml/vocabularies/apiBinding#exclusive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | string | string | - | The value of the IBM MQ topic string to be used. | `http://a.ml/vocabularies/apiBinding#string` | | objectName | string | - | The name of the IBM MQ topic object. | `http://a.ml/vocabularies/apiBinding#objectName` | | durablePermitted | boolean | - | Defines if the subscription may be durable. | `http://a.ml/vocabularies/apiBinding#durablePermitted` | | lastMsgRetained | boolean | - | Defines if the last message published will be made available to new subscriptions. | `http://a.ml/vocabularies/apiBinding#lastMsgRetained` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | messageType | string | - | The type of the message | `http://a.ml/vocabularies/apiBinding#messageType` | | headers | [string] | false | Defines 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` | | description | string | - | | `http://a.ml/vocabularies/core#description` | | expiry | int | - | This is a period of time expressed in milliseconds and set by the application that puts the message. | `http://a.ml/vocabularies/apiBinding#expiry` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | groupId | string | - | 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` | | ccdtQueueManagerName | string | - | The name of the IBM MQ queue manager to bind to in the CCDT file. | `http://a.ml/vocabularies/apiBinding#ccdtQueueManagerName` | | cipherSpec | string | - | 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` | | multiEndpointServer | boolean | - | 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` | | heartBeatInterval | int | - | 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` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | templateVariable | string | - | Variable defined inside an URL template | `http://a.ml/vocabularies/apiContract#templateVariable` | | linkExpression | string | - | OAS 3 link expression | `http://a.ml/vocabularies/apiContract#linkExpression` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | ## 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [[JsonLDElement](#jsonldelement)] | false | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | schemaVersion | string | - | JSON Schema version of the document | `http://a.ml/vocabularies/document#schemaVersion` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topic | string | - | Kafka topic name if different from channel name. | `http://a.ml/vocabularies/apiBinding#topic` | | partitions | int | - | Number of partitions configured on this topic. | `http://a.ml/vocabularies/apiBinding#partitions` | | replicas | int | - | Number of replicas configured on this topic. | `http://a.ml/vocabularies/apiBinding#replicas` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topic | string | - | Kafka topic name if different from channel name. | `http://a.ml/vocabularies/apiBinding#topic` | | partitions | int | - | Number of partitions configured on this topic. | `http://a.ml/vocabularies/apiBinding#partitions` | | replicas | int | - | Number of replicas configured on this topic. | `http://a.ml/vocabularies/apiBinding#replicas` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topicConfiguration040 | [KafkaTopicConfiguration040](#kafkatopicconfiguration040) | - | Topic configuration properties that are relevant for the API. | `http://a.ml/vocabularies/apiBinding#topicConfiguration040` | | topic | string | - | Kafka topic name if different from channel name. | `http://a.ml/vocabularies/apiBinding#topic` | | partitions | int | - | Number of partitions configured on this topic. | `http://a.ml/vocabularies/apiBinding#partitions` | | replicas | int | - | Number of replicas configured on this topic. | `http://a.ml/vocabularies/apiBinding#replicas` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topicConfiguration050 | [KafkaTopicConfiguration050](#kafkatopicconfiguration050) | - | Topic configuration properties that are relevant for the API. | `http://a.ml/vocabularies/apiBinding#topicConfiguration050` | | topic | string | - | Kafka topic name if different from channel name. | `http://a.ml/vocabularies/apiBinding#topic` | | partitions | int | - | Number of partitions configured on this topic. | `http://a.ml/vocabularies/apiBinding#partitions` | | replicas | int | - | Number of replicas configured on this topic. | `http://a.ml/vocabularies/apiBinding#replicas` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | messageKey | [Shape](#shape) | - | Schema that defines the message key | `http://a.ml/vocabularies/apiBinding#messageKey` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | messageKey | [Shape](#shape) | - | Schema that defines the message key | `http://a.ml/vocabularies/apiBinding#messageKey` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | schemaIdLocation | string | - | 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` | | schemaIdPayloadEncoding | string | - | 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` | | schemaLookupStrategy | string | - | 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` | | messageKey | [Shape](#shape) | - | Schema that defines the message key | `http://a.ml/vocabularies/apiBinding#messageKey` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | groupId | [Shape](#shape) | - | Schema that defines the id of the consumer group | `http://a.ml/vocabularies/apiBinding#groupId` | | clientId | [Shape](#shape) | - | Schema that defines the id of the consumer inside a consumer group | `http://a.ml/vocabularies/apiBinding#clientId` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | schemaRegistryUrl | string | - | API URL for the Schema Registry used when producing Kafka messages (if a Schema Registry was used) | `http://a.ml/vocabularies/apiBinding#schemaRegistryUrl` | | schemaRegistryVendor | string | - | The vendor of Schema Registry and Kafka serdes library that should be used | `http://a.ml/vocabularies/apiBinding#schemaRegistryVendor` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | CleanupPolicy | [string] | false | The cleanup.policy configuration option. | `http://a.ml/vocabularies/apiBinding#CleanupPolicy` | | RetentionMs | int | - | The retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionMs` | | RetentionBytes | int | - | The retention.bytes configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionBytes` | | DeleteRetentionMs | int | - | The delete.retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#DeleteRetentionMs` | | MaxMessageBytes | int | - | 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | CleanupPolicy | [string] | false | The cleanup.policy configuration option. | `http://a.ml/vocabularies/apiBinding#CleanupPolicy` | | RetentionMs | int | - | The retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionMs` | | RetentionBytes | int | - | The retention.bytes configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionBytes` | | DeleteRetentionMs | int | - | The delete.retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#DeleteRetentionMs` | | MaxMessageBytes | int | - | 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | ConfluentKeySchemaValidation | boolean | - | It shows whether the schema validation for the message key is enabled. Vendor specific config. | `http://a.ml/vocabularies/apiBinding#ConfluentKeySchemaValidation` | | ConfluentKeySubjectNameStrategy | string | - | The name of the schema lookup strategy for the message key. Vendor specific config. | `http://a.ml/vocabularies/apiBinding#ConfluentKeySubjectNameStrategy` | | ConfluentValueSchemaValidation | boolean | - | It shows whether the schema validation for the message value is enabled. Vendor specific config. | `http://a.ml/vocabularies/apiBinding#ConfluentValueSchemaValidation` | | ConfluentValueSubjectNameStrategy | string | - | The name of the schema lookup strategy for the message value. Vendor specific config. | `http://a.ml/vocabularies/apiBinding#ConfluentValueSubjectNameStrategy` | | CleanupPolicy | [string] | false | The cleanup.policy configuration option. | `http://a.ml/vocabularies/apiBinding#CleanupPolicy` | | RetentionMs | int | - | The retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionMs` | | RetentionBytes | int | - | The retention.bytes configuration option. | `http://a.ml/vocabularies/apiBinding#RetentionBytes` | | DeleteRetentionMs | int | - | The delete.retention.ms configuration option. | `http://a.ml/vocabularies/apiBinding#DeleteRetentionMs` | | MaxMessageBytes | int | - | 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | keyComponents | [[PropertyShapePath](#propertyshapepath)] | false | Components that make up this Key | `http://a.ml/vocabularies/federation#keyComponents` | | isResolvable | boolean | - | | `http://a.ml/vocabularies/federation#isResolvable` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | url | url | - | URL identifying the organization | `http://a.ml/vocabularies/core#url` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | identifier | string | - | SPDX license expression for the API | `http://a.ml/vocabularies/core#identifier` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | value | string | - | | `http://a.ml/vocabularies/data#value` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | location | string | - | Location of the metadata document that generated this base unit | `http://a.ml/vocabularies/document#location` | | elements | [url] | false | Elements which all belong to a certain source location | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | items | [Shape](#shape) | - | Shapes inside the data arrangement | `http://a.ml/vocabularies/shapes#items` | | contains | [Shape](#shape) | - | One of the shapes in the data arrangement | `http://a.ml/vocabularies/shapes#contains` | | minCount | int | - | Minimum items count constraint | `http://www.w3.org/ns/shacl#minCount` | | maxCount | int | - | Maximum items count constraint | `http://www.w3.org/ns/shacl#maxCount` | | uniqueItems | boolean | - | Unique items constraint | `http://a.ml/vocabularies/shapes#uniqueItems` | | collectionFormat | string | - | Input collection format information | `http://a.ml/vocabularies/shapes#collectionFormat` | | unevaluatedItems | boolean | - | Accepts that items may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedItems` | | unevaluatedItemsSchema | [Shape](#shape) | - | Items that may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedItemsSchema` | | qualifiedMinCount | int | - | Minimum number of value nodes constraint | `http://www.w3.org/ns/shacl#qualifiedMinCount` | | qualifiedMaxCount | int | - | Maximum number of value nodes constraint | `http://www.w3.org/ns/shacl#qualifiedMaxCount` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | payload | [[Payload](#payload)] | false | Payload for a Request/Response | `http://a.ml/vocabularies/apiContract#payload` | | correlationId | [CorrelationId](#correlationid) | - | An identifier that can be used for message tracing and correlation | `http://a.ml/vocabularies/core#correlationId` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | title | string | - | Title of the item | `http://a.ml/vocabularies/core#title` | | summary | string | - | Human readable short description of the request/response | `http://a.ml/vocabularies/core#summary` | | header | [[Parameter](#parameter)] | false | Parameter passed as a header to an operation for communication models | `http://a.ml/vocabularies/apiContract#header` | | binding | [MessageBindings](#messagebindings) | - | Bindings for this request/response | `http://a.ml/vocabularies/apiBinding#binding` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | isAbstract | boolean | - | Defines a model as abstract | `http://a.ml/vocabularies/apiContract#isAbstract` | | headerExamples | [[Example](#example)] | false | Examples for a header definition | `http://a.ml/vocabularies/apiContract#headerExamples` | | headerSchema | [NodeShape](#nodeshape) | - | Object Schema who's properties are headers for the message. | `http://a.ml/vocabularies/apiContract#headerSchema` | | messageId | string | - | Unique Id for request and response message | `http://a.ml/vocabularies/apiContract#messageId` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | bindings | [[MessageBinding](#messagebinding)] | false | List of message bindings | `http://a.ml/vocabularies/apiBinding#bindings` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | declares | [[DomainElement](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | payloadFormatIndicator | int | - | 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` | | correlationData | [Shape](#shape) | - | 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` | | contentType | string | - | 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` | | responseTopic | string | - | The topic (channel URI) for a response message. | `http://a.ml/vocabularies/apiBinding#responseTopic` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | qos | int | - | Defines how hard the broker/client will try to ensure that a message is received | `http://a.ml/vocabularies/apiBinding#qos` | | retain | boolean | - | Whether the broker should retain the message or not | `http://a.ml/vocabularies/apiBinding#retain` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | qos | int | - | Defines how hard the broker/client will try to ensure that a message is received | `http://a.ml/vocabularies/apiBinding#qos` | | retain | boolean | - | Whether the broker should retain the message or not | `http://a.ml/vocabularies/apiBinding#retain` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | messageExpiryInterval | int | - | Interval in seconds or a Schema Object containing the definition of the lifetime of the message. | `http://a.ml/vocabularies/apiBinding#messageExpiryInterval` | | qos | int | - | Defines how hard the broker/client will try to ensure that a message is received | `http://a.ml/vocabularies/apiBinding#qos` | | retain | boolean | - | Whether the broker should retain the message or not | `http://a.ml/vocabularies/apiBinding#retain` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | clientId | string | - | The client identifier | `http://a.ml/vocabularies/apiBinding#clientId` | | cleanSession | boolean | - | Whether to create a persistent connection or not | `http://a.ml/vocabularies/apiBinding#cleanSession` | | lastWill | [MqttServerLastWill](#mqttserverlastwill) | - | Last Will and Testament configuration | `http://a.ml/vocabularies/apiBinding#lastWill` | | keepAlive | int | - | Interval in seconds of the longest period of time the broker and the client can endure without sending a message | `http://a.ml/vocabularies/apiBinding#keepAlive` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | clientId | string | - | The client identifier | `http://a.ml/vocabularies/apiBinding#clientId` | | cleanSession | boolean | - | Whether to create a persistent connection or not | `http://a.ml/vocabularies/apiBinding#cleanSession` | | lastWill | [MqttServerLastWill](#mqttserverlastwill) | - | Last Will and Testament configuration | `http://a.ml/vocabularies/apiBinding#lastWill` | | keepAlive | int | - | Interval in seconds of the longest period of time the broker and the client can endure without sending a message | `http://a.ml/vocabularies/apiBinding#keepAlive` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | sessionExpiryInterval | int | - | 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` | | sessionExpiryIntervalSchema | [Shape](#shape) | - | 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` | | maximumPacketSize | int | - | Number of bytes or a Schema Object representing the maximum packet size the client is willing to accept. | `http://a.ml/vocabularies/apiBinding#maximumPacketSize` | | maximumPacketSizeSchema | [Shape](#shape) | - | Number of bytes or a Schema Object representing the maximum packet size the client is willing to accept. | `http://a.ml/vocabularies/apiBinding#maximumPacketSizeSchema` | | clientId | string | - | The client identifier | `http://a.ml/vocabularies/apiBinding#clientId` | | cleanSession | boolean | - | Whether to create a persistent connection or not | `http://a.ml/vocabularies/apiBinding#cleanSession` | | lastWill | [MqttServerLastWill](#mqttserverlastwill) | - | Last Will and Testament configuration | `http://a.ml/vocabularies/apiBinding#lastWill` | | keepAlive | int | - | Interval in seconds of the longest period of time the broker and the client can endure without sending a message | `http://a.ml/vocabularies/apiBinding#keepAlive` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topic | string | - | The topic where the Last Will and Testament message will be sent | `http://a.ml/vocabularies/apiBinding#topic` | | qos | int | - | Defines how hard the broker/client will try to ensure that the Last Will and Testament message is received | `http://a.ml/vocabularies/apiBinding#qos` | | retain | boolean | - | Whether the broker should retain the Last Will and Testament message or not | `http://a.ml/vocabularies/apiBinding#retain` | | message | string | - | Message used to notify other clients about an ungracefully disconnected client. | `http://a.ml/vocabularies/apiBinding#message` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | scope | [[Scope](#scope)] | false | | `http://a.ml/vocabularies/security#scope` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | targetClass | url | - | Target class whose instances will need to match the constraint described for the node | `http://www.w3.org/ns/shacl#targetClass` | | name | string | - | Name of the node mappable element | `http://a.ml/vocabularies/core#name` | | property | [[PropertyMapping](#propertymapping)] | false | Data shape constraint for a property of the target node | `http://www.w3.org/ns/shacl#property` | | uriTemplate | string | - | URI template that will be used to generate the URI of the parsed nodeds in the graph | `http://a.ml/vocabularies/apiContract#uriTemplate` | | mergePolicy | string | - | Indication of how to merge this graph node when applying a patch document | `http://a.ml/vocabularies/meta#mergePolicy` | | resolvedExtends | [url] | false | | `http://a.ml/vocabularies/meta#resolvedExtends` | | closed | boolean | - | Additional properties in the input node accepted constraint | `http://www.w3.org/ns/shacl#closed` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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] | false | Logical and composition of data | `http://a.ml/vocabularies/amf/aml#and` | | or | [url] | false | Logical or composition of data | `http://a.ml/vocabularies/amf/aml#or` | | components | [url] | false | Array of component mappings in case of component combination generated mapping | `http://a.ml/vocabularies/amf/aml#components` | | if | url | - | Conditional constraint if over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#if` | | then | url | - | Conditional constraint then over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#then` | | else | url | - | Conditional constraint else over the type of the mapped graph property | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | isAbstract | boolean | - | Marks this shape as an abstract node shape declared for pure re-use | `http://a.ml/vocabularies/shapes#isAbstract` | | minProperties | int | - | Minimum number of properties in the input node constraint | `http://a.ml/vocabularies/shapes#minProperties` | | maxProperties | int | - | Maximum number of properties in the input node constraint | `http://a.ml/vocabularies/shapes#maxProperties` | | closed | boolean | - | Additional properties in the input node accepted constraint | `http://www.w3.org/ns/shacl#closed` | | additionalPropertiesKeySchema | [Shape](#shape) | - | Additional properties key schema | `http://www.w3.org/ns/shacl#additionalPropertiesKeySchema` | | additionalPropertiesSchema | [Shape](#shape) | - | Additional properties schema | `http://www.w3.org/ns/shacl#additionalPropertiesSchema` | | discriminator | string | - | Discriminator property | `http://a.ml/vocabularies/shapes#discriminator` | | discriminatorValue | string | - | Values for the discriminator property | `http://a.ml/vocabularies/shapes#discriminatorValue` | | discriminatorValueDataNode | [DataNode](#datanode) | - | Value for the discriminator property represented as a DataNode | `http://a.ml/vocabularies/shapes#discriminatorValueDataNode` | | discriminatorMapping | [[IriTemplateMapping](#iritemplatemapping)] | false | Mapping of acceptable values for the node discriminator | `http://a.ml/vocabularies/shapes#discriminatorMapping` | | discriminatorValueMapping | [[DiscriminatorValueMapping](#discriminatorvaluemapping)] | false | Mapping of acceptable values for the node discriminator | `http://a.ml/vocabularies/shapes#discriminatorValueMapping` | | property | [[PropertyShape](#propertyshape)] | false | Properties associated to this node | `http://www.w3.org/ns/shacl#property` | | propertyNames | [Shape](#shape) | - | Property names schema | `http://www.w3.org/ns/shacl#propertyNames` | | dependencies | [[PropertyDependencies](#propertydependencies)] | false | Dependent properties constraint | `http://a.ml/vocabularies/shapes#dependencies` | | schemaDependencies | [[SchemaDependencies](#schemadependencies)] | false | Applied schemas if property exists constraint | `http://a.ml/vocabularies/shapes#schemaDependencies` | | unevaluatedProperties | boolean | - | Accepts that properties may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedProperties` | | unevaluatedPropertiesSchema | [Shape](#shape) | - | Properties that may not be evaluated in schema validation | `http://a.ml/vocabularies/shapes#unevaluatedPropertiesSchema` | | supportedOperation | [[ShapeOperation](#shapeoperation)] | false | Supported operations for this shape | `http://a.ml/vocabularies/shapes#supportedOperation` | | inputOnly | boolean | - | Indicates if the shape is used as schema for input data only | `http://a.ml/vocabularies/shapes#inputOnly` | | keys | [[Key](#key)] | false | Keys of this Node Shape in the federated graph | `http://a.ml/vocabularies/federation#keys` | | externalProperty | [[ExternalPropertyShape](#externalpropertyshape)] | false | Properties imported from external graphs | `http://a.ml/vocabularies/federation#externalProperty` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | requestTokenUri | string | - | | `http://a.ml/vocabularies/security#requestTokenUri` | | authorizationUri | string | - | | `http://a.ml/vocabularies/security#authorizationUri` | | tokenCredentialsUri | string | - | | `http://a.ml/vocabularies/security#tokenCredentialsUri` | | signature | [string] | false | | `http://a.ml/vocabularies/security#signature` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | authorizationUri | string | - | | `http://a.ml/vocabularies/security#authorizationUri` | | accessTokenUri | string | - | | `http://a.ml/vocabularies/security#accessTokenUri` | | flow | string | - | | `http://a.ml/vocabularies/security#flow` | | refreshUri | string | - | | `http://a.ml/vocabularies/security#refreshUri` | | scope | [[Scope](#scope)] | false | | `http://a.ml/vocabularies/security#scope` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | authorizationGrant | [string] | false | | `http://a.ml/vocabularies/security#authorizationGrant` | | flows | [[OAuth2Flow](#oauth2flow)] | false | | `http://a.ml/vocabularies/security#flows` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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: | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | ## 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | | description | string | - | Human readable description of an element | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | displayName | string | - | Human readable name for the property term | `http://a.ml/vocabularies/core#displayName` | | description | string | - | Human readable description of the property term | `http://a.ml/vocabularies/core#description` | | range | url | - | Range of the proeprty term, scalar or object | `http://www.w3.org/2000/01/rdf-schema#range` | | subPropertyOf | [url] | false | Subsumption relationship for terms | `http://www.w3.org/2000/01/rdf-schema#subPropertyOf` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | openIdConnectUrl | string | - | | `http://a.ml/vocabularies/security#openIdConnectUrl` | | scope | [[Scope](#scope)] | false | | `http://a.ml/vocabularies/security#scope` | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | method | string | - | HTTP method required to invoke the operation | `http://a.ml/vocabularies/apiContract#method` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | deprecated | boolean | - | Marks the operation as deprecated | `http://a.ml/vocabularies/core#deprecated` | | guiSummary | string | - | Human readable description of the operation | `http://a.ml/vocabularies/apiContract#guiSummary` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | scheme | [string] | false | URI scheme for the API protocol | `http://a.ml/vocabularies/apiContract#scheme` | | accepts | [string] | false | Media-types accepted in a API request | `http://a.ml/vocabularies/apiContract#accepts` | | mediaType | [string] | false | Media types returned by a API response | `http://a.ml/vocabularies/core#mediaType` | | expects | [[Request](#request)] | false | Request information required by the operation | `http://a.ml/vocabularies/apiContract#expects` | | returns | [[Response](#response)] | false | Response data returned by the operation | `http://a.ml/vocabularies/apiContract#returns` | | security | [[SecurityRequirement](#securityrequirement)] | false | Security schemes applied to an element in the API spec | `http://a.ml/vocabularies/security#security` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | callback | [[Callback](#callback)] | false | Associated callbacks | `http://a.ml/vocabularies/apiContract#callback` | | server | [[Server](#server)] | false | Server information | `http://a.ml/vocabularies/apiContract#server` | | binding | [OperationBindings](#operationbindings) | - | Bindings for this operation | `http://a.ml/vocabularies/apiBinding#binding` | | isAbstract | boolean | - | Defines a model as abstract | `http://a.ml/vocabularies/apiContract#isAbstract` | | operationId | string | - | Identifier of the target operation | `http://a.ml/vocabularies/apiContract#operationId` | | federationMetadata | [OperationFederationMetadata](#operationfederationmetadata) | - | Metadata about how this Operation should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | bindings | [[OperationBinding](#operationbinding)] | false | List of operation bindings | `http://a.ml/vocabularies/apiBinding#bindings` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | providedEntity | [NodeShape](#nodeshape) | - | Node shape provided by this Operation to the federated graph | `http://a.ml/vocabularies/federation#providedEntity` | | federationMethod | string | - | REST method (e.g. GET, POST) used to retrieve an entity. Overrides the Method from the current operation | `http://a.ml/vocabularies/federation#federationMethod` | | keyMappings | [[ParameterKeyMapping](#parameterkeymapping)] | false | Mapping from parameters to properties from the provided entity to be used for data retrieval | `http://a.ml/vocabularies/federation#keyMappings` | | name | string | - | Name element in the federated graph | `http://a.ml/vocabularies/federation#name` | | tags | [string] | false | Federation tags of the element | `http://a.ml/vocabularies/federation#tags` | | shareable | boolean | - | Element can be defined by more than one component of the federated graph | `http://a.ml/vocabularies/federation#shareable` | | inaccessible | boolean | - | Element cannot be accessed by the federated graph | `http://a.ml/vocabularies/federation#inaccessible` | | overrideFrom | string | - | Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argument | `http://a.ml/vocabularies/federation#overrideFrom` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | url | url | - | URL identifying the organization | `http://a.ml/vocabularies/core#url` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | email | string | - | Contact email for the organization | `http://a.ml/vocabularies/core#email` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | extends | url | - | Target base unit being extended by this extension model | `http://a.ml/vocabularies/document#extends` | | encodes | [DomainElement](#domainelement) | - | 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](#domainelement)] | false | The 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` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | paramName | string | - | Name of a parameter | `http://a.ml/vocabularies/apiContract#paramName` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | required | boolean | - | Marks the parameter as required | `http://a.ml/vocabularies/apiContract#required` | | deprecated | boolean | - | Marks the parameter as deprecated | `http://a.ml/vocabularies/document#deprecated` | | allowEmptyValue | boolean | - | Parameter can be passed without value | `http://a.ml/vocabularies/apiContract#allowEmptyValue` | | style | string | - | Encoding style for the parameter information | `http://a.ml/vocabularies/apiContract#style` | | explode | boolean | - | | `http://a.ml/vocabularies/apiContract#explode` | | allowReserved | boolean | - | | `http://a.ml/vocabularies/apiContract#allowReserved` | | binding | string | - | Part of the Request model where the parameter can be encoded (header, path, query param, etc.) | `http://a.ml/vocabularies/apiContract#binding` | | schema | [Shape](#shape) | - | Schema the parameter value must validate | `http://a.ml/vocabularies/shapes#schema` | | payload | [[Payload](#payload)] | false | | `http://a.ml/vocabularies/apiContract#payload` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a parameter | `http://a.ml/vocabularies/core#defaultValue` | | federationMetadata | [ParameterFederationMetadata](#parameterfederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name element in the federated graph | `http://a.ml/vocabularies/federation#name` | | tags | [string] | false | Federation tags of the element | `http://a.ml/vocabularies/federation#tags` | | shareable | boolean | - | Element can be defined by more than one component of the federated graph | `http://a.ml/vocabularies/federation#shareable` | | inaccessible | boolean | - | Element cannot be accessed by the federated graph | `http://a.ml/vocabularies/federation#inaccessible` | | overrideFrom | string | - | Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argument | `http://a.ml/vocabularies/federation#overrideFrom` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | mappingSource | [Parameter](#parameter) | - | Parameter to use as source for this mapping | `http://a.ml/vocabularies/federation#mappingSource` | | mappingTarget | [PropertyShapePath](#propertyshapepath) | - | Path to target Property Shape of this mapping | `http://a.ml/vocabularies/federation#mappingTarget` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | target | [AbstractDeclaration](#abstractdeclaration) | - | Target node for the parameter | `http://a.ml/vocabularies/document#target` | | variable | [[VariableValue](#variablevalue)] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | target | [AbstractDeclaration](#abstractdeclaration) | - | Target node for the parameter | `http://a.ml/vocabularies/document#target` | | variable | [[VariableValue](#variablevalue)] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name for the security scheme | `http://a.ml/vocabularies/core#name` | | scheme | [SecurityScheme](#securityscheme) | - | | `http://a.ml/vocabularies/security#scheme` | | settings | [Settings](#settings) | - | Security scheme settings | `http://a.ml/vocabularies/security#settings` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | target | [AbstractDeclaration](#abstractdeclaration) | - | Target node for the parameter | `http://a.ml/vocabularies/document#target` | | variable | [[VariableValue](#variablevalue)] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | mediaType | string | - | Media types supported in the payload | `http://a.ml/vocabularies/core#mediaType` | | schemaMediaType | string | - | Defines the format of the payload schema | `http://a.ml/vocabularies/apiContract#schemaMediaType` | | schema | [Shape](#shape) | - | Schema associated to this payload | `http://a.ml/vocabularies/shapes#schema` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | encoding | [[Encoding](#encoding)] | false | An array of properties and its encoding information. The key, being the property name, must exist in the schema as a property | `http://a.ml/vocabularies/apiContract#encoding` | | required | boolean | - | Marks the payload as required | `http://a.ml/vocabularies/apiContract#required` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | mediaType | string | - | HTTP Media type associated to the encoded fragment information | `http://a.ml/vocabularies/core#mediaType` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | propertySource | string | - | Source property name in the dependency | `http://a.ml/vocabularies/shapes#propertySource` | | propertyTarget | [string] | false | Target property name in the dependency | `http://a.ml/vocabularies/shapes#propertyTarget` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | mappingSource | [PropertyShape](#propertyshape) | - | Property Shape to use as source for this mapping | `http://a.ml/vocabularies/federation#mappingSource` | | mappingTarget | string | - | Name of external target Property Shape of this mapping | `http://a.ml/vocabularies/federation#mappingTarget` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | path | url | - | URI for the mapped graph property derived from this mapping | `http://www.w3.org/ns/shacl#path` | | name | string | - | Name in the source AST for the mapping | `http://a.ml/vocabularies/core#name` | | datatype | url | - | Scalar constraint over the type of the mapped graph property | `http://www.w3.org/ns/shacl#datatype` | | node | [url] | true | Object constraint over the type of the mapped graph property | `http://www.w3.org/ns/shacl#node` | | mapProperty | string | - | Marks the mapping as a 'map' mapping syntax. Directly related with mapTermKeyProperty | `http://a.ml/vocabularies/meta#mapProperty` | | mapValueProperty | string | - | Marks the mapping as a 'map value' mapping syntax. Directly related with mapTermValueProperty | `http://a.ml/vocabularies/meta#mapValueProperty` | | mapTermProperty | url | - | Marks the mapping as a 'map' mapping syntax. | `http://a.ml/vocabularies/meta#mapTermProperty` | | mapTermValueProperty | url | - | Marks the mapping as a 'map value' mapping syntax | `http://a.ml/vocabularies/meta#mapTermValueProperty` | | minCount | int | - | Minimum count constraint over the mapped property | `http://www.w3.org/ns/shacl#minCount` | | pattern | string | - | Pattern constraint over the mapped property | `http://www.w3.org/ns/shacl#pattern` | | minInclusive | double | - | Minimum inclusive constraint over the mapped property | `http://www.w3.org/ns/shacl#minInclusive` | | maxInclusive | double | - | Maximum inclusive constraint over the mapped property | `http://www.w3.org/ns/shacl#maxInclusive` | | allowMultiple | boolean | - | Allows multiple mapped nodes for the property mapping | `http://a.ml/vocabularies/meta#allowMultiple` | | sorted | boolean | - | Marks the mapping as requiring order in the mapped collection of nodes | `http://a.ml/vocabularies/meta#sorted` | | in | [Any] | true | Enum constraint for the values of the property mapping | `http://www.w3.org/ns/shacl#in` | | typeDiscriminatorMap | string | - | Information about the discriminator values in the source AST for the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorMap` | | unique | boolean | - | Marks the values for the property mapping as a primary key for this type of node | `http://a.ml/vocabularies/meta#unique` | | externallyLinkable | boolean | - | Marks this object property as supporting external links | `http://a.ml/vocabularies/meta#externallyLinkable` | | mandatory | boolean | - | Mandatory constraint over the property. Different from minCount because it only checks the presence of property | `http://www.w3.org/ns/shacl#mandatory` | | typeDiscriminatorName | string | - | Information about the field in the source AST to be used as discrimintaro in the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorName` | | mergePolicy | string | - | Indication of how to merge this graph node when applying a patch document | `http://a.ml/vocabularies/meta#mergePolicy` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | path | url | - | Path to the constrained property | `http://www.w3.org/ns/shacl#path` | | range | [Shape](#shape) | - | Range property constraint | `http://a.ml/vocabularies/shapes#range` | | minCount | int | - | Minimum count property constraint | `http://www.w3.org/ns/shacl#minCount` | | maxCount | int | - | Maximum count property constraint | `http://www.w3.org/ns/shacl#maxCount` | | patternName | string | - | Patterned property constraint | `http://a.ml/vocabularies/shapes#patternName` | | serializationOrder | int | - | position in the set of properties for a shape used to serialize this property on the wire | `http://a.ml/vocabularies/shapes#serializationOrder` | | requires | [[PropertyShapePath](#propertyshapepath)] | false | External properties (by path) required to retrieve data from this property during federation | `http://a.ml/vocabularies/federation#requires` | | provides | [[PropertyShapePath](#propertyshapepath)] | false | External properties (by path) that can be provided by this graph during federation | `http://a.ml/vocabularies/federation#provides` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | path | [[PropertyShape](#propertyshape)] | true | represents a property shape path in a traversal to reach a particular Shape | `http://a.ml/vocabularies/shapes#path` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the mapping | `http://a.ml/vocabularies/core#name` | | mappedNode | url | - | Node in the dialect definition associated to this mapping | `http://a.ml/vocabularies/meta#mappedNode` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | namespace | string | - | The namespace the channel is associated with. | `http://a.ml/vocabularies/apiBinding#namespace` | | persistence | string | - | Persistence of the topic in Pulsar. It MUST be either persistent or non-persistent. | `http://a.ml/vocabularies/apiBinding#persistence` | | compaction | int | - | Topic compaction threshold given in Megabytes. | `http://a.ml/vocabularies/apiBinding#compaction` | | geo-replication | [string] | false | A list of clusters the topic is replicated to. | `http://a.ml/vocabularies/apiBinding#geo-replication` | | retention | [PulsarChannelRetention](#pulsarchannelretention) | - | Topic retention policy. | `http://a.ml/vocabularies/apiBinding#retention` | | ttl | int | - | Message time-to-live in seconds. | `http://a.ml/vocabularies/apiBinding#ttl` | | deduplication | boolean | - | 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` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | time | int | - | Time given in Minutes. Defaults to 0 | `http://a.ml/vocabularies/apiBinding#time` | | size | int | - | Size given in MegaBytes. Defaults to 0 | `http://a.ml/vocabularies/apiBinding#size` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | tenant | string | - | The pulsar tenant. If omitted, "public" MUST be assumed. | `http://a.ml/vocabularies/apiBinding#tenant` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | fixPoint | url | - | Link to the base of the recursion for a recursive shape | `http://a.ml/vocabularies/shapes#fixPoint` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | required | boolean | - | Marks the parameter as required | `http://a.ml/vocabularies/apiContract#required` | | parameter | [[Parameter](#parameter)] | false | Parameters associated to the communication model | `http://a.ml/vocabularies/apiContract#parameter` | | queryString | [Shape](#shape) | - | Query string for the communication model | `http://a.ml/vocabularies/apiContract#queryString` | | uriParameter | [[Parameter](#parameter)] | false | | `http://a.ml/vocabularies/apiContract#uriParameter` | | cookieParameter | [[Parameter](#parameter)] | false | | `http://a.ml/vocabularies/apiContract#cookieParameter` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | payload | [[Payload](#payload)] | false | Payload for a Request/Response | `http://a.ml/vocabularies/apiContract#payload` | | correlationId | [CorrelationId](#correlationid) | - | An identifier that can be used for message tracing and correlation | `http://a.ml/vocabularies/core#correlationId` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | title | string | - | Title of the item | `http://a.ml/vocabularies/core#title` | | summary | string | - | Human readable short description of the request/response | `http://a.ml/vocabularies/core#summary` | | header | [[Parameter](#parameter)] | false | Parameter passed as a header to an operation for communication models | `http://a.ml/vocabularies/apiContract#header` | | binding | [MessageBindings](#messagebindings) | - | Bindings for this request/response | `http://a.ml/vocabularies/apiBinding#binding` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | isAbstract | boolean | - | Defines a model as abstract | `http://a.ml/vocabularies/apiContract#isAbstract` | | headerExamples | [[Example](#example)] | false | Examples for a header definition | `http://a.ml/vocabularies/apiContract#headerExamples` | | headerSchema | [NodeShape](#nodeshape) | - | Object Schema who's properties are headers for the message. | `http://a.ml/vocabularies/apiContract#headerSchema` | | messageId | string | - | Unique Id for request and response message | `http://a.ml/vocabularies/apiContract#messageId` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | dataNode | [DataNode](#datanode) | - | Associated dynamic structure for the declaration | `http://a.ml/vocabularies/document#dataNode` | | variable | [string] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | statusCode | string | - | HTTP status code returned by a response | `http://a.ml/vocabularies/apiContract#statusCode` | | link | [[TemplatedLink](#templatedlink)] | false | Structural definition of links on the source data shape AST | `http://a.ml/vocabularies/apiContract#link` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | payload | [[Payload](#payload)] | false | Payload for a Request/Response | `http://a.ml/vocabularies/apiContract#payload` | | correlationId | [CorrelationId](#correlationid) | - | An identifier that can be used for message tracing and correlation | `http://a.ml/vocabularies/core#correlationId` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | title | string | - | Title of the item | `http://a.ml/vocabularies/core#title` | | summary | string | - | Human readable short description of the request/response | `http://a.ml/vocabularies/core#summary` | | header | [[Parameter](#parameter)] | false | Parameter passed as a header to an operation for communication models | `http://a.ml/vocabularies/apiContract#header` | | binding | [MessageBindings](#messagebindings) | - | Bindings for this request/response | `http://a.ml/vocabularies/apiBinding#binding` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | isAbstract | boolean | - | Defines a model as abstract | `http://a.ml/vocabularies/apiContract#isAbstract` | | headerExamples | [[Example](#example)] | false | Examples for a header definition | `http://a.ml/vocabularies/apiContract#headerExamples` | | headerSchema | [NodeShape](#nodeshape) | - | Object Schema who's properties are headers for the message. | `http://a.ml/vocabularies/apiContract#headerSchema` | | messageId | string | - | Unique Id for request and response message | `http://a.ml/vocabularies/apiContract#messageId` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | value | string | - | value for an scalar dynamic node | `http://a.ml/vocabularies/data#value` | | datatype | url | - | Data type of value for an scalar dynamic node | `http://www.w3.org/ns/shacl#datatype` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | datatype | url | - | Scalar range constraining this scalar shape | `http://www.w3.org/ns/shacl#datatype` | | encoding | string | - | Describes the contents' value encoding | `http://a.ml/vocabularies/shapes#encoding` | | mediaType | string | - | Describes the content's value mediatype | `http://a.ml/vocabularies/shapes#mediaType` | | contentSchema | [Shape](#shape) | - | Describes the content's value structure | `http://a.ml/vocabularies/shapes#contentSchema` | | pattern | string | - | Pattern constraint | `http://www.w3.org/ns/shacl#pattern` | | minLength | int | - | Minimum lenght constraint | `http://www.w3.org/ns/shacl#minLength` | | maxLength | int | - | Maximum length constraint | `http://www.w3.org/ns/shacl#maxLength` | | minInclusive | double | - | Minimum inclusive constraint | `http://www.w3.org/ns/shacl#minInclusive` | | maxInclusive | double | - | Maximum inclusive constraint | `http://www.w3.org/ns/shacl#maxInclusive` | | minExclusive | boolean | - | Minimum exclusive constraint | `http://www.w3.org/ns/shacl#minExclusive` | | maxExclusive | boolean | - | Maximum exclusive constraint | `http://www.w3.org/ns/shacl#maxExclusive` | | exclusiveMinimumNumeric | double | - | Minimum exclusive constraint | `http://a.ml/vocabularies/shapes#exclusiveMinimumNumeric` | | exclusiveMaximumNumeric | double | - | Maximum exclusive constraint | `http://a.ml/vocabularies/shapes#exclusiveMaximumNumeric` | | format | string | - | Format constraint | `http://a.ml/vocabularies/shapes#format` | | multipleOf | double | - | Multiple of constraint | `http://a.ml/vocabularies/shapes#multipleOf` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | propertySource | string | - | Source property name in the dependency | `http://a.ml/vocabularies/shapes#propertySource` | | schemaTarget | [Shape](#shape) | - | Target applied shape in the dependency | `http://a.ml/vocabularies/shapes#schemaTarget` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | mediaType | string | - | Media type associated to a shape | `http://a.ml/vocabularies/core#mediaType` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the scope | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description for the scope | `http://a.ml/vocabularies/core#description` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | schemes | [[ParametrizedSecurityScheme](#parametrizedsecurityscheme)] | false | | `http://a.ml/vocabularies/security#schemes` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name for the security scheme | `http://a.ml/vocabularies/core#name` | | type | string | - | Type of security scheme | `http://a.ml/vocabularies/security#type` | | displayName | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#displayName` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | header | [[Parameter](#parameter)] | false | Parameter passed as a header to an operation for communication models | `http://a.ml/vocabularies/apiContract#header` | | parameter | [[Parameter](#parameter)] | false | Parameters associated to the communication model | `http://a.ml/vocabularies/apiContract#parameter` | | response | [[Response](#response)] | false | Response associated to this security scheme | `http://a.ml/vocabularies/apiContract#response` | | settings | [Settings](#settings) | - | Security scheme settings | `http://a.ml/vocabularies/security#settings` | | queryString | [Shape](#shape) | - | Query string for the communication model | `http://a.ml/vocabularies/apiContract#queryString` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | base | [BaseIRI](#baseiri) | - | Base IRI used to generate all the @ids in the model | `http://a.ml/vocabularies/meta#base` | | vocab | [DefaultVocabulary](#defaultvocabulary) | - | Default IRI prefix used to map by default all properties and terms in the model | `http://a.ml/vocabularies/meta#vocab` | | curies | [[CuriePrefix](#curieprefix)] | false | Set of CURIE prefixes defined in a context | `http://a.ml/vocabularies/meta#curies` | | mappings | [[ContextMapping](#contextmapping)] | false | Set of property mappings and coercions defined in a context | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name that identifies an extension in the target document | `http://a.ml/vocabularies/core#name` | | extensionMappingDefinition | url | - | Extension mapping (annotation mapping) definition used to parse a certain extension identified with the ExtensionName | `http://a.ml/vocabularies/meta#extensionMappingDefinition` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | urlTemplate | string | - | URL (potentially a template) for the server | `http://a.ml/vocabularies/core#urlTemplate` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | tags | [[Parameter](#parameter)] | false | Tags for the different Servers | `http://a.ml/vocabularies/apiContract#tags` | | variable | [[Parameter](#parameter)] | false | Variables in the URL for the server | `http://a.ml/vocabularies/apiContract#variable` | | protocol | string | - | The protocol this URL supports for connection | `http://a.ml/vocabularies/apiContract#protocol` | | protocolVersion | string | - | The version of the protocol used for connection | `http://a.ml/vocabularies/apiContract#protocolVersion` | | security | [[SecurityRequirement](#securityrequirement)] | false | Textual indication of the kind of security scheme used | `http://a.ml/vocabularies/security#security` | | binding | [ServerBindings](#serverbindings) | - | Bindings for this server | `http://a.ml/vocabularies/apiBinding#binding` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | bindings | [[ServerBinding](#serverbinding)] | false | List of server bindings | `http://a.ml/vocabularies/apiBinding#bindings` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | additionalProperties | [DataNode](#datanode) | - | | `http://a.ml/vocabularies/security#additionalProperties` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | definedBy | [CustomDomainProperty](#customdomainproperty) | - | Definition for the extended entity | `http://a.ml/vocabularies/document#definedBy` | | extension | [DataNode](#datanode) | - | Data structure associated to the extension | `http://a.ml/vocabularies/document#extension` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name element in the federated graph | `http://a.ml/vocabularies/federation#name` | | tags | [string] | false | Federation tags of the element | `http://a.ml/vocabularies/federation#tags` | | shareable | boolean | - | Element can be defined by more than one component of the federated graph | `http://a.ml/vocabularies/federation#shareable` | | inaccessible | boolean | - | Element cannot be accessed by the federated graph | `http://a.ml/vocabularies/federation#inaccessible` | | overrideFrom | string | - | Indicates that the current subgraph is taking responsibility for resolving the marked field away from the subgraph specified in the from argument | `http://a.ml/vocabularies/federation#overrideFrom` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | expects | [[ShapeRequest](#shaperequest)] | false | Request information required by the operation | `http://a.ml/vocabularies/shapes#expects` | | returns | [[ShapeResponse](#shaperesponse)] | false | Response data returned by the operation | `http://a.ml/vocabularies/shapes#returns` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | paramName | string | - | Name of a parameter | `http://a.ml/vocabularies/shapes#paramName` | | binding | string | - | Part of the Request model where the parameter can be encoded (header, path, query param, etc.) | `http://a.ml/vocabularies/shapes#binding` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | required | boolean | - | Marks the parameter as required | `http://a.ml/vocabularies/shapes#required` | | schema | [Shape](#shape) | - | Schema the parameter value must validate | `http://a.ml/vocabularies/shapes#schema` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a parameter | `http://a.ml/vocabularies/core#defaultValue` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | schema | [Shape](#shape) | - | Schema associated to this payload | `http://a.ml/vocabularies/shapes#schema` | | mediaType | string | - | Media types supported in the payload | `http://a.ml/vocabularies/core#mediaType` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | parameter | [[ShapeParameter](#shapeparameter)] | false | Parameters associated to the communication model | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | payload | [ShapePayload](#shapepayload) | - | Payload for a Request/Response | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinations | [[SolaceOperationDestination](#solaceoperationdestination)] | false | | `http://a.ml/vocabularies/apiBinding#destinations` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinations | [[SolaceOperationDestination010](#solaceoperationdestination010)] | false | | `http://a.ml/vocabularies/apiBinding#destinations` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinations | [[SolaceOperationDestination020](#solaceoperationdestination020)] | false | | `http://a.ml/vocabularies/apiBinding#destinations` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinations | [[SolaceOperationDestination030](#solaceoperationdestination030)] | false | | `http://a.ml/vocabularies/apiBinding#destinations` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinations | [[SolaceOperationDestination040](#solaceoperationdestination040)] | false | | `http://a.ml/vocabularies/apiBinding#destinations` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | timeToLive | int | - | Interval in milliseconds or a Schema Object containing the definition of the lifetime of the message. | `http://a.ml/vocabularies/apiBinding#timeToLive` | | priority | int | - | 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` | | dmqEligible | boolean | - | 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` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue](#solaceoperationqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue010](#solaceoperationqueue010) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue](#solaceoperationqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue010](#solaceoperationqueue010) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | topic | [SolaceOperationTopic](#solaceoperationtopic) | - | Defines the properties of a topic. | `http://a.ml/vocabularies/apiBinding#topic` | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue](#solaceoperationqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue030](#solaceoperationqueue030) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | topic | [SolaceOperationTopic](#solaceoperationtopic) | - | Defines the properties of a topic. | `http://a.ml/vocabularies/apiBinding#topic` | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue](#solaceoperationqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue030](#solaceoperationqueue030) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | bindingVersion | string | - | The binding version. | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | topic | [SolaceOperationTopic](#solaceoperationtopic) | - | Defines the properties of a topic. | `http://a.ml/vocabularies/apiBinding#topic` | | destinationType | string | - | '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` | | deliveryMode | string | - | 'direct' or 'persistent'. This determines the quality of service for publishing messages. Default is 'persistent'. | `http://a.ml/vocabularies/apiBinding#deliveryMode` | | queue | [SolaceOperationQueue](#solaceoperationqueue) | - | Defines the properties of a queue. | `http://a.ml/vocabularies/apiBinding#queue` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topicSubscriptions | [string] | false | A 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` | | accessType | string | - | 'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'. | `http://a.ml/vocabularies/apiBinding#accessType` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topicSubscriptions | [string] | false | A 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` | | accessType | string | - | 'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'. | `http://a.ml/vocabularies/apiBinding#accessType` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | maxMsgSpoolSize | string | - | The maximum size of the message spool used by the queue. | `http://a.ml/vocabularies/apiBinding#maxMsgSpoolSize` | | maxTtl | string | - | The maximum time-to-live for messages in the queue. | `http://a.ml/vocabularies/apiBinding#maxTtl` | | topicSubscriptions | [string] | false | A 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` | | accessType | string | - | 'exclusive' or 'nonexclusive'. Only applicable when destinationType is 'queue'. | `http://a.ml/vocabularies/apiBinding#accessType` | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | topicSubscriptions | [string] | false | A 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](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | msgVpn | string | - | The Virtual Private Network name on the Solace broker. | `http://a.ml/vocabularies/apiBinding#msgVpn` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | msgVpn | string | - | The Virtual Private Network name on the Solace broker. | `http://a.ml/vocabularies/apiBinding#msgVpn` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | msgVpn | string | - | The Virtual Private Network name on the Solace broker. | `http://a.ml/vocabularies/apiBinding#msgVpn` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | clientName | string | - | 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` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | ## 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | documentation | [CreativeWork](#creativework) | - | Documentation about the tag | `http://a.ml/vocabularies/core#documentation` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | ## TemplatedLink Templated link containing URL template and variables mapping Types: * `http://a.ml/vocabularies/apiContract#TemplatedLink` * `http://a.ml/vocabularies/document#DomainElement` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | template | string | - | URL template for a templated link | `http://a.ml/vocabularies/apiContract#template` | | operationId | string | - | Identifier of the target operation | `http://a.ml/vocabularies/apiContract#operationId` | | mapping | [[IriTemplateMapping](#iritemplatemapping)] | false | Variable mapping for the URL template | `http://a.ml/vocabularies/apiContract#mapping` | | requestBody | string | - | | `http://a.ml/vocabularies/apiContract#requestBody` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | server | [Server](#server) | - | | `http://a.ml/vocabularies/apiContract#server` | | extends | [[DomainElement](#domainelement)] | false | Entity 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-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | dataNode | [DataNode](#datanode) | - | Associated dynamic structure for the declaration | `http://a.ml/vocabularies/document#dataNode` | | variable | [string] | false | Variables to be replaced in the graph template introduced by an AbstractDeclaration | `http://a.ml/vocabularies/document#variable` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | encodes | [DomainElement](#domainelement) | - | The encodes relationship links a parsing Unit with the DomainElement from a particular domain the unit contains. | `http://a.ml/vocabularies/document#encodes` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | items | [[Shape](#shape)] | true | Shapes contained in the Tuple Shape | `http://a.ml/vocabularies/shapes#items` | | minCount | int | - | Minimum items count constraint | `http://www.w3.org/ns/shacl#minCount` | | maxCount | int | - | Maximum items count constraint | `http://www.w3.org/ns/shacl#maxCount` | | uniqueItems | boolean | - | Unique items constraint | `http://a.ml/vocabularies/shapes#uniqueItems` | | closedItems | boolean | - | Constraint limiting additional shapes in the collection | `http://a.ml/vocabularies/shapes#closedItems` | | additionalItemsSchema | [Shape](#shape) | - | Controls whether it’s valid to have additional items in the array beyond what is defined | `http://a.ml/vocabularies/shapes#additionalItemsSchema` | | collectionFormat | string | - | Input collection format information | `http://a.ml/vocabularies/shapes#collectionFormat` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the node mappable element | `http://a.ml/vocabularies/core#name` | | typeDiscriminatorMap | string | - | Information about the discriminator values in the source AST for the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorMap` | | typeDiscriminatorName | string | - | Information about the field in the source AST to be used as discrimintaro in the property mapping | `http://a.ml/vocabularies/meta#typeDiscriminatorName` | | node | [url] | true | Object constraint over the type of the mapped graph property | `http://www.w3.org/ns/shacl#node` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | extends | [[DomainElement](#domainelement)] | false | Entity 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] | false | Logical and composition of data | `http://a.ml/vocabularies/amf/aml#and` | | or | [url] | false | Logical or composition of data | `http://a.ml/vocabularies/amf/aml#or` | | components | [url] | false | Array of component mappings in case of component combination generated mapping | `http://a.ml/vocabularies/amf/aml#components` | | if | url | - | Conditional constraint if over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#if` | | then | url | - | Conditional constraint then over the type of the mapped graph property | `http://a.ml/vocabularies/amf/aml#then` | | else | url | - | Conditional constraint else over the type of the mapped graph property | `http://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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | anyOf | [[Shape](#shape)] | false | Data shapes in the union | `http://a.ml/vocabularies/shapes#anyOf` | | link-target | url | - | URI of the linked element | `http://a.ml/vocabularies/document#link-target` | | link-label | string | - | Label for the type of link | `http://a.ml/vocabularies/document#link-label` | | recursive | boolean | - | Indication taht this kind of linkable element can support recursive links | `http://a.ml/vocabularies/document#recursive` | | name | string | - | Name for a data shape | `http://www.w3.org/ns/shacl#name` | | name | string | - | Human readable name for the term | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | defaultValue | [DataNode](#datanode) | - | Default value parsed for a data shape property | `http://www.w3.org/ns/shacl#defaultValue` | | in | [[DataNode](#datanode)] | true | Enumeration of possible values for a data shape property | `http://www.w3.org/ns/shacl#in` | | inherits | [[Shape](#shape)] | false | Relationship of inheritance between data shapes | `http://a.ml/vocabularies/shapes#inherits` | | defaultValueStr | string | - | Textual representation of the parsed default value for the shape property | `http://www.w3.org/ns/shacl#defaultValueStr` | | not | [Shape](#shape) | - | Logical not composition of data shapes | `http://www.w3.org/ns/shacl#not` | | and | [[Shape](#shape)] | false | Logical and composition of data shapes | `http://www.w3.org/ns/shacl#and` | | or | [[Shape](#shape)] | false | Logical or composition of data shapes | `http://www.w3.org/ns/shacl#or` | | xone | [[Shape](#shape)] | false | Logical exclusive or composition of data shapes | `http://www.w3.org/ns/shacl#xone` | | closure | [url] | false | Transitive closure of data shapes this particular shape inherits structure from | `http://a.ml/vocabularies/shapes#closure` | | if | [Shape](#shape) | - | Condition for applying composition of data shapes | `http://www.w3.org/ns/shacl#if` | | then | [Shape](#shape) | - | Composition of data shape when if data shape is valid | `http://www.w3.org/ns/shacl#then` | | else | [Shape](#shape) | - | Composition of data shape when if data shape is invalid | `http://www.w3.org/ns/shacl#else` | | readOnly | boolean | - | Read only property constraint | `http://a.ml/vocabularies/shapes#readOnly` | | writeOnly | boolean | - | Write only property constraint | `http://a.ml/vocabularies/shapes#writeOnly` | | serializationSchema | [Shape](#shape) | - | Serialization schema for a shape | `http://a.ml/vocabularies/shapes#serializationSchema` | | deprecated | boolean | - | Deprecated annotation for a property constraint | `http://a.ml/vocabularies/shapes#deprecated` | | isExtension | boolean | - | Indicates if a Shape is an extension of another shape or a standalone shape | `http://a.ml/vocabularies/shapes#isExtension` | | federationMetadata | [ShapeFederationMetadata](#shapefederationmetadata) | - | Metadata about how this DomainElement should be federated | `http://a.ml/vocabularies/federation#federationMetadata` | | isStub | boolean | - | Indicates if an element is a stub from an external component from another component of the federated graph | `http://a.ml/vocabularies/federation#isStub` | | documentation | [CreativeWork](#creativework) | - | Documentation for a particular part of the model | `http://a.ml/vocabularies/core#documentation` | | xmlSerialization | [XMLSerializer](#xmlserializer) | - | Information about how to serialize | `http://a.ml/vocabularies/shapes#xmlSerialization` | | comment | string | - | A comment on an item. The comment's content is expressed via the text | `http://a.ml/vocabularies/core#comment` | | schemaVersion | string | - | Determine which dialect should be used when processing the schema | `http://a.ml/vocabularies/shapes#schemaVersion` | | examples | [[Example](#example)] | false | Examples for a particular domain element | `http://a.ml/vocabularies/apiContract#examples` | | namespace | string | - | (AVRO) a JSON string that qualifies the name | `http://a.ml/vocabularies/shapes#namespace` | | aliases | [string] | false | (AVRO) a JSON array of strings, providing alternate names for this shape | `http://a.ml/vocabularies/shapes#aliases` | | size | int | - | (AVRO) an integer specifying the number of bytes per value | `http://a.ml/vocabularies/shapes#size` | | raw | string | - | Raw textual information that cannot be processed for the current model semantics. | `http://a.ml/vocabularies/document#raw` | | reference-id | url | - | Internal identifier for an inlined fragment | `http://a.ml/vocabularies/document#reference-id` | | location | string | - | Location of an inlined fragment | `http://a.ml/vocabularies/document#location` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | name of the template variable | `http://a.ml/vocabularies/core#name` | | value | [DataNode](#datanode) | - | value of the variables | `http://a.ml/vocabularies/document#value` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name for an entity | `http://a.ml/vocabularies/core#name` | | imports | [[VocabularyReference](#vocabularyreference)] | false | import relationships between vocabularies | `http://www.w3.org/2002/07/owl#imports` | | externals | [[External](#external)] | false | | `http://a.ml/vocabularies/meta#externals` | | declares | [[DomainElement](#domainelement)] | false | The 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` | | base | string | - | Base URI prefix for definitions in this vocabulary | `http://a.ml/vocabularies/meta#base` | | location | string | - | Location of the metadata document that generated this base unit | `http://a.ml/vocabularies/document#location` | | version | string | - | Version of the current model | `http://a.ml/vocabularies/document#version` | | references | [[BaseUnit](#baseunit)] | false | references across base units | `http://a.ml/vocabularies/document#references` | | usage | string | - | Human readable description of the unit | `http://a.ml/vocabularies/document#usage` | | describedBy | url | - | Link to the AML dialect describing a particular subgraph of information | `http://a.ml/vocabularies/meta#describedBy` | | root | boolean | - | Indicates if the base unit represents the root of the document model obtained from parsing | `http://a.ml/vocabularies/document#root` | | package | string | - | Logical identifier providing a common namespace for the information in this base unit | `http://a.ml/vocabularies/document#package` | | processingData | [BaseUnitProcessingData](#baseunitprocessingdata) | - | Field with utility data to be used in Base Unit processing | `http://a.ml/vocabularies/document#processingData` | | sourceInformation | [BaseUnitSourceInformation](#baseunitsourceinformation) | - | Contains information of the source from which the base unit was generated | `http://a.ml/vocabularies/document#sourceInformation` | ## VocabularyReference Types: * `http://a.ml/vocabularies/meta#VocabularyReference` * `http://a.ml/vocabularies/document#DomainElement` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | alias | string | - | | `http://a.ml/vocabularies/document#alias` | | reference | string | - | | `http://a.ml/vocabularies/document#reference` | | base | string | - | | `http://a.ml/vocabularies/meta#base` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | name | string | - | Name of the shape | `http://a.ml/vocabularies/core#name` | | description | string | - | Human readable description of an element | `http://a.ml/vocabularies/core#description` | | identifier | string | - | The identifier property represents any kind of identifier, such as ISBNs, GTIN codes, UUIDs, etc. | `http://a.ml/vocabularies/core#identifier` | | server | [[Server](#server)] | false | Server information | `http://a.ml/vocabularies/apiContract#server` | | accepts | [string] | false | Media-types accepted in a API request | `http://a.ml/vocabularies/apiContract#accepts` | | contentType | [string] | false | Media types returned by a API response | `http://a.ml/vocabularies/apiContract#contentType` | | scheme | [string] | false | URI scheme for the API protocol | `http://a.ml/vocabularies/apiContract#scheme` | | version | string | - | Version of the API | `http://a.ml/vocabularies/core#version` | | termsOfService | string | - | Terms and conditions when using the API | `http://a.ml/vocabularies/core#termsOfService` | | provider | [Organization](#organization) | - | Organization providing some kind of asset or service | `http://a.ml/vocabularies/core#provider` | | license | [License](#license) | - | License for the API | `http://a.ml/vocabularies/core#license` | | documentation | [[CreativeWork](#creativework)] | false | Documentation associated to the API | `http://a.ml/vocabularies/core#documentation` | | endpoint | [[EndPoint](#endpoint)] | false | End points defined in the API | `http://a.ml/vocabularies/apiContract#endpoint` | | webhooks | [[EndPoint](#endpoint)] | false | Webhooks defined in the API | `http://a.ml/vocabularies/apiContract#webhooks` | | security | [[SecurityRequirement](#securityrequirement)] | false | Textual indication of the kind of security scheme used | `http://a.ml/vocabularies/security#security` | | tag | [[Tag](#tag)] | false | Additionally custom tagged information | `http://a.ml/vocabularies/apiContract#tag` | | defaultSchema | string | - | The default value for the $schema keyword within Schema Objects | `http://a.ml/vocabularies/apiContract#defaultSchema` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | method | string | - | The HTTP method to use when establishing the connection | `http://a.ml/vocabularies/apiBinding#method` | | query | [Shape](#shape) | - | A Schema object containing the definitions for each query parameter | `http://a.ml/vocabularies/apiBinding#query` | | headers | [Shape](#shape) | - | A Schema object containing the definitions for HTTP-specific headers | `http://a.ml/vocabularies/apiBinding#headers` | | bindingVersion | string | - | The version of this binding | `http://a.ml/vocabularies/apiBinding#bindingVersion` | | type | string | - | Binding for a corresponding known type | `http://a.ml/vocabularies/apiBinding#type` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` | Name | Value | Sorted | Documentation | Namespace | | ------ | ------ | ------ | ------ | ------ | | xmlAttribute | boolean | - | XML attribute mapping | `http://a.ml/vocabularies/shapes#xmlAttribute` | | xmlWrapped | boolean | - | XML wrapped mapping flag | `http://a.ml/vocabularies/shapes#xmlWrapped` | | xmlName | string | - | XML name mapping | `http://a.ml/vocabularies/shapes#xmlName` | | xmlNamespace | string | - | XML namespace mapping | `http://a.ml/vocabularies/shapes#xmlNamespace` | | xmlPrefix | string | - | XML prefix mapping | `http://a.ml/vocabularies/shapes#xmlPrefix` | | extends | [[DomainElement](#domainelement)] | false | Entity 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` |