ReadMe · JSON-LD Context

Readme Context

JSON-LD context defining the semantic vocabulary for Readme from ReadMe.

35 Classes 0 Properties 3 Namespaces

View Context View on GitHub

Namespaces

schema: https://schema.org/

readme: https://readme.com/ns/

openapi: https://spec.openapis.org/oas/3.1#

Classes

Project Branch APIDefinition Guide ChangelogPost CustomPage Category APIKey Recipe MetricsRequest MCPServer id type name title slug body category parentDoc branch version isStable isBeta isDeprecated createdAt updatedAt publishedAt source filename label group request response transport tools

JSON-LD Document

{
  "@context": {
    "@version": 1.1,
    "schema": "https://schema.org/",
    "readme": "https://readme.com/ns/",
    "openapi": "https://spec.openapis.org/oas/3.1#",
    "Project": "schema:Product",
    "Branch": "readme:Branch",
    "APIDefinition": "readme:APIDefinition",
    "Guide": "schema:Article",
    "ChangelogPost": "schema:Article",
    "CustomPage": "schema:WebPage",
    "Category": "readme:Category",
    "APIKey": "readme:APIKey",
    "Recipe": "readme:Recipe",
    "MetricsRequest": "readme:MetricsRequest",
    "MCPServer": "readme:MCPServer",
    "id": "@id",
    "type": "@type",
    "name": "schema:name",
    "title": "schema:headline",
    "slug": "readme:slug",
    "body": "schema:articleBody",
    "category": "schema:about",
    "parentDoc": "readme:parentDoc",
    "branch": "readme:branch",
    "version": "schema:version",
    "isStable": "readme:isStable",
    "isBeta": "readme:isBeta",
    "isDeprecated": "readme:isDeprecated",
    "createdAt": "schema:dateCreated",
    "updatedAt": "schema:dateModified",
    "publishedAt": "schema:datePublished",
    "source": "schema:source",
    "filename": "schema:identifier",
    "label": "schema:name",
    "group": "schema:audience",
    "request": "readme:request",
    "response": "readme:response",
    "transport": "readme:transport",
    "tools": "readme:tools"
  }
}