jsonschema

Documentation

Overview

Package jsonschema builds the JSON Schema of the document `pista parse` writes. It reflects over parser.ParseResult, so the schema follows the structs rather than a description kept beside them.

Index

• Constants
• func Build() (*jsonschema.Schema, error)
• func Marshal() ([]byte, error)

Constants

const ID = "https://winebarrel.github.io/pistachio/json/schema-" + Version + ".json"

ID is the URL the documentation site carries the schema at.

const Path = "docs/json/schema-" + Version + ".json"

Path is where the file sits in the repository and on the documentation site.

const Version = "1.0"

Version is the version the schema's file name and URL carry.

Functions

func Build

func Build() (*jsonschema.Schema, error)

Build returns the schema of a `pista parse` document.

func Marshal

func Marshal() ([]byte, error)

Marshal returns the schema as the file holds it: indented, and with the trailing newline a text file ends on.