APIGen · JSON-LD Context

Apigen Context

JSON-LD context defining the semantic vocabulary for Apigen from APIGen.

29 Classes 10 Properties 1 Namespaces
View Context View on GitHub

Namespaces

apigen: https://api.apigen.com/vocab#

Classes

id type Project Api Endpoint Schema Connector Deployment Test TestRun User Token name description url version status environment method path generationSource prompt requestSchema responseSchema region replicas scopes email organization

Properties

Property Type Container
projectId reference
apiId reference
endpointId reference
connectorId reference
ownerId reference
deployedBy reference
specUrl reference
createdAt DateTime
updatedAt DateTime
expiresAt DateTime

JSON-LD Document

Raw ↑ 
{
  "@context": {
    "@vocab": "https://schema.org/",
    "apigen": "https://api.apigen.com/vocab#",
    "id": "@id",
    "type": "@type",
    "Project": "apigen:Project",
    "Api": "apigen:Api",
    "Endpoint": "apigen:Endpoint",
    "Schema": "apigen:Schema",
    "Connector": "apigen:Connector",
    "Deployment": "apigen:Deployment",
    "Test": "apigen:Test",
    "TestRun": "apigen:TestRun",
    "User": "Person",
    "Token": "apigen:Token",
    "name": "name",
    "description": "description",
    "url": "url",
    "version": "softwareVersion",
    "status": "apigen:status",
    "environment": "apigen:environment",
    "method": "apigen:httpMethod",
    "path": "apigen:urlPath",
    "projectId": {
      "@id": "apigen:project",
      "@type": "@id"
    },
    "apiId": {
      "@id": "apigen:api",
      "@type": "@id"
    },
    "endpointId": {
      "@id": "apigen:endpoint",
      "@type": "@id"
    },
    "connectorId": {
      "@id": "apigen:connector",
      "@type": "@id"
    },
    "ownerId": {
      "@id": "apigen:owner",
      "@type": "@id"
    },
    "deployedBy": {
      "@id": "apigen:deployedBy",
      "@type": "@id"
    },
    "generationSource": "apigen:generationSource",
    "prompt": "apigen:prompt",
    "specUrl": {
      "@id": "apigen:specUrl",
      "@type": "@id"
    },
    "requestSchema": "apigen:requestSchema",
    "responseSchema": "apigen:responseSchema",
    "region": "apigen:region",
    "replicas": "apigen:replicas",
    "scopes": "apigen:scopes",
    "email": "email",
    "organization": "memberOf",
    "createdAt": {
      "@id": "dateCreated",
      "@type": "DateTime"
    },
    "updatedAt": {
      "@id": "dateModified",
      "@type": "DateTime"
    },
    "expiresAt": {
      "@id": "expires",
      "@type": "DateTime"
    }
  }
}