<- Go to Data Types Go to ToC

1. Definition 2. Functional Requirements 3. Syntax 4. Semantics

1 Definition

AIM Description describes an AIM, Basic or Composite, implementation in terms of Identifier, Types, Ports and Documentation.

2 Functional Requirements

An AIM Implementer shall produce an AIM Description for publication that contains the properties described in the Semantics.

3 Syntax

https://schemas.mpai.community/MAS/V1.1/data/AIMDescription.json

4 Semantics

Label Description
Header AIM Description Header – Standard “MAS-AID-V1.1”
Identifier Container uniquely identifying the AIM implementation describing either an MPAI‑standard‑defined or an Implementer‑defined AIM.
– ImplementerID Identifier assigned by IIDRA to the Implementer.
– ImplementationID Identifier assigned by Implementer to the specific Implementation. The Identifier shall be unique in the Implementer name space.
– AIM The AIM name as defined by the Standard.
– Profile Profile of the as defined by the Standard, if present.
APIProfile AIF API Profile selected by the Implementer: Basic or Secure.
Description Free‑text description of the AIM.
Types Dictionary (array) of Channel data type shorthands.
– Name Unique shorthand used for a Channel data type.
– Type Channel data type referenced by the shorthand.
Ports Array of Ports (physical or logical interfaces) through which the AIM communicates.
– Name Implementer‑defined port name.
– Direction Direction of the communication flow: OutputInput or InputOutput.
– RecordType Port data type (defined in Types or per the governing section 6.1.1).
– Protocol Protocol entry (ontology value).
– Bout Whether the Port may be given as a Bout (MPAI-AIF): an output Port by the SCI, an input Port by an RCA that holds an Instance Credential of the SCI (API 2.1).
Documentation References to documents relevant to design, implementation, and usage.
– Type Type of the document: Specification, Manual, Tutorial, or Video.
– URI Valid URI for the referenced document.

<- Go to Data Types Go to ToC