RAML · JSON-LD Context

Raml Context

JSON-LD context defining the semantic vocabulary for Raml from RAML.

15 Classes 18 Properties 5 Namespaces
View Context View on GitHub

Namespaces

raml: https://raml.org/vocab#
schema: https://schema.org/
xsd: http://www.w3.org/2001/XMLSchema#
dcterms: http://purl.org/dc/terms/
owl: http://www.w3.org/2002/07/owl#

Classes

RAMLDocument Resource Method TypeDeclaration Trait ResourceType SecurityScheme AnnotationType Library title description example examples displayName uriParameters

Properties

Property Type Container
version
baseUri anyURI
protocols list
mediaType
types reference
traits reference
resourceTypes reference
securitySchemes reference
annotationTypes reference
securedBy list
uses reference
queryParameters
headers
body
responses
properties
required boolean
is list

JSON-LD Document

raml-context.jsonld Raw ↑
{
  "@context": {
    "@version": 1.1,
    "raml": "https://raml.org/vocab#",
    "schema": "https://schema.org/",
    "xsd": "http://www.w3.org/2001/XMLSchema#",
    "dcterms": "http://purl.org/dc/terms/",
    "owl": "http://www.w3.org/2002/07/owl#",

    "RAMLDocument": "raml:Document",
    "Resource": "raml:Resource",
    "Method": "raml:Method",
    "TypeDeclaration": "raml:TypeDeclaration",
    "Trait": "raml:Trait",
    "ResourceType": "raml:ResourceType",
    "SecurityScheme": "raml:SecurityScheme",
    "AnnotationType": "raml:AnnotationType",
    "Library": "raml:Library",

    "title": "dcterms:title",
    "description": "dcterms:description",
    "version": {
      "@id": "schema:version"
    },
    "baseUri": {
      "@id": "raml:baseUri",
      "@type": "xsd:anyURI"
    },
    "protocols": {
      "@id": "raml:protocols",
      "@container": "@list"
    },
    "mediaType": {
      "@id": "raml:mediaType"
    },
    "types": {
      "@id": "raml:types",
      "@type": "@id"
    },
    "traits": {
      "@id": "raml:traits",
      "@type": "@id"
    },
    "resourceTypes": {
      "@id": "raml:resourceTypes",
      "@type": "@id"
    },
    "securitySchemes": {
      "@id": "raml:securitySchemes",
      "@type": "@id"
    },
    "annotationTypes": {
      "@id": "raml:annotationTypes",
      "@type": "@id"
    },
    "securedBy": {
      "@id": "raml:securedBy",
      "@container": "@list"
    },
    "uses": {
      "@id": "raml:uses",
      "@type": "@id"
    },
    "queryParameters": {
      "@id": "raml:queryParameters"
    },
    "headers": {
      "@id": "raml:headers"
    },
    "body": {
      "@id": "raml:body"
    },
    "responses": {
      "@id": "raml:responses"
    },
    "properties": {
      "@id": "raml:properties"
    },
    "required": {
      "@id": "raml:required",
      "@type": "xsd:boolean"
    },
    "example": "raml:example",
    "examples": "raml:examples",
    "displayName": "raml:displayName",
    "uriParameters": "raml:uriParameters",
    "is": {
      "@id": "raml:appliedTraits",
      "@container": "@list"
    }
  }
}