Markdown examples

Simple model

A simple model with some scalar properties.

{
  "definitions": {
    "Student": {
      "description": "A simple student struct",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    }
  },
  "root": "Student"
}

Student.md

# Student

A simple student struct

Field | Type | Description
----- | ---- | -----------
firstName | String | 
lastName | String | 
age | Integer |

Model with inheritance

A student struct which extends from a different struct.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        }
      }
    },
    "Student": {
      "parent": {
        "type": "reference",
        "target": "Human"
      },
      "type": "struct",
      "properties": {
        "studentId": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Human.md

# Human

Field | Type | Description
----- | ---- | -----------
firstName | String | 
lastName | String | 
age | Integer |

Student.md

# Student

Field | Type | Description
----- | ---- | -----------
studentId | String |

Model with reference

A student struct which reference a faculty struct.

{
  "definitions": {
    "Student": {
      "description": "A student struct with an assigned faculty",
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "faculty": {
          "type": "reference",
          "target": "Faculty"
        }
      }
    },
    "Faculty": {
      "type": "struct",
      "properties": {
        "name": {
          "type": "string"
        }
      }
    }
  },
  "root": "Student"
}

Student.md

# Student

A student struct with an assigned faculty

Field | Type | Description
----- | ---- | -----------
firstName | String | 
lastName | String | 
age | Integer | 
faculty | Faculty |

Faculty.md

# Faculty

Field | Type | Description
----- | ---- | -----------
name | String |

Map with string values

A student struct which contains a map with arbitrary string values.

{
  "definitions": {
    "Student": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "age": {
          "type": "integer"
        },
        "properties": {
          "type": "map",
          "schema": {
            "type": "string"
          }
        }
      }
    }
  },
  "root": "Student"
}

Student.md

# Student

Field | Type | Description
----- | ---- | -----------
firstName | String | 
lastName | String | 
age | Integer | 
properties | Map (String) |

Model with discriminator

A struct which uses a discriminator mapping.

{
  "definitions": {
    "Human": {
      "type": "struct",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        },
        "location": {
          "type": "reference",
          "target": "Location"
        }
      }
    },
    "Location": {
      "type": "struct",
      "base": true,
      "properties": {
        "type": {
          "type": "string"
        }
      },
      "discriminator": "type",
      "mapping": {
        "Web": "web",
        "World": "world"
      }
    },
    "Web": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "url": {
          "type": "string"
        }
      }
    },
    "World": {
      "parent": {
        "type": "reference",
        "target": "Location"
      },
      "type": "struct",
      "properties": {
        "lat": {
          "type": "string"
        },
        "long": {
          "type": "string"
        }
      }
    }
  },
  "root": "Human"
}

Human.md

# Human

Field | Type | Description
----- | ---- | -----------
firstName | String | 
lastName | String | 
location | Location |

Location.md

# Location

Field | Type | Description
----- | ---- | -----------
type | String |

Web.md

# Web

Field | Type | Description
----- | ---- | -----------
url | String |

World.md

# World

Field | Type | Description
----- | ---- | -----------
lat | String | 
long | String |

Model with generics

A struct which uses generics.

{
  "definitions": {
    "Student": {
      "type": "object",
      "properties": {
        "matricleNumber": {
          "type": "integer"
        }
      }
    },
    "StudentMap": {
      "type": "struct",
      "parent": {
        "type": "reference",
        "target": "Map",
        "template": {
          "T": "Student"
        }
      }
    },
    "Map": {
      "type": "object",
      "properties": {
        "totalResults": {
          "type": "integer"
        },
        "entries": {
          "type": "array",
          "schema": {
            "type": "generic",
            "name": "T"
          }
        }
      }
    }
  },
  "root": "StudentMap"
}

Student.md

# Student

Field | Type | Description
----- | ---- | -----------
matricleNumber | Integer |

Map.md

# Map

Field | Type | Description
----- | ---- | -----------
totalResults | Integer | 
entries | Array (T) |

StudentMap.md

# StudentMap

Field | Type | Description
----- | ---- | -----------

Import other TypeSchema specification

A struct which references an external TypeSchema.

{
  "import": {
    "my_ns": "file:///generic.json"
  },
  "definitions": {
    "Faculty": {
      "type": "object",
      "properties": {
        "description": {
          "type": "string"
        },
        "students": {
          "type": "array",
          "schema": {
            "type": "reference",
            "target": "my_ns:StudentMap"
          }
        }
      }
    }
  },
  "root": "Faculty"
}

Faculty.md

# Faculty

Field | Type | Description
----- | ---- | -----------
description | String | 
students | Array (my_ns:StudentMap) |

Edit this page