Contracts

todo

This should actually be an example of contract terms, not just a copy of the schemae.

YAML

Parser

bedoc_parser_lpc.yaml

# yaml-language-server: $schema=https://schema.gesslar.dev/bedoc/v1/bedoc-action.json
provides:
type: object
properties:
  functions:
    type: array
    items:
      type: object
      properties:
        name:
          type: string
        description:
          type: array
          items:
            type: string
        param:
          type: array
          items:
            type: object
            properties:
              type:
                type: string
              name:
                type: string
              content:
                type: array
                items:
                  type: string
        return:
          type: object
          properties:
            type:
              type: string
            content:
              type: array
              items:
                type: string
        example:
          type: array
          items:
            type: string

Printer

bedoc_parser_wikitext.yaml

# yaml-language-server: $schema=https://schema.gesslar.dev/bedoc/v1/bedoc-action.json
accepts:
type: object
required:
  - functions
properties:
  functions:
    type: array
    items:
      type: object
      required:
        - name
      properties:
        name:
          type: string
        description:
          type: array
          items:
            type: string
        param:
          type: array
          items:
            type: object
            required:
              - name
              - type
            properties:
              type:
                oneOf:
                  - type: string
                  - type: array
                    items:
                      type: string
              name:
                type: string
              content:
                type: array
                items:
                  type: string
        return:
          type: object
          required:
            - type
          properties:
            type:
              oneOf:
                - type: string
                - type: array
                  items:
                    type: string
            content:
              type: array
              items:
                type: string
        example:
          type: array
          items:
            type: string

JSON

Parser

bedoc_parser_lpc.json

{
  $schema: "https://schema.gesslar.dev/bedoc/v1/bedoc-action.json",
  provides: {
    type: "object",
    properties: {
      functions: {
        type: "array",
        items: {
          type: "object",
          properties: {
            name: {
              type: "string"
            },
            description: {
              type: "array",
              items: {
                type: "string"
              }
            },
            param: {
              type: "array",
              items: {
                type: "object",
                properties: {
                  type: {
                    type: "string"
                  },
                  name: {
                    type: "string"
                  },
                  content: {
                    type: "array",
                    items: {
                      type: "string"
                    }
                  }
                }
              }
            },
            return: {
              type: "object",
              properties: {
                type: {
                  type: "string"
                },
                content: {
                  type: "array",
                  items: {
                    type: "string"
                  }
                }
              }
            },
            example: {
              type: "array",
              items: {
                type: "string"
              }
            }
          }
        }
      }
    }
  }
}

Printer

bedoc_printer_wikitext.json

{
  $schema: "https://schema.gesslar.dev/bedoc/v1/bedoc-action.json",
  accepts: {
    type: "object",
    required: [
      functions
    ],
    properties: {
      functions: {
        type: "array",
        items: {
          type: "object",
          required: [
            "name"
          ],
          properties: {
            name: {
              type: "string"
            },
            description: {
              type: "array",
              items: {
                type: "string"
              }
            },
            param: {
              type: "array",
              items: {
                type: "object",
                required: [
                  "name",
                  "type"
                ],
                properties: {
                  type: {
                    oneOf: [
                      {
                        type: "string"
                      },
                      {
                        type: "array",
                        items: {
                          type: "string"
                        }
                      }
                    ]
                  },
                  name: {
                    type: "string"
                  },
                  content: {
                    type: "array",
                    items: {
                      type: "string"
                    }
                  }
                }
              }
            },
            return: {
              type: "object",
              required: [
                "type"
              ],
              properties: {
                type: {
                  oneOf: [
                    {
                      type: "string"
                    },
                    {
                      type: "array",
                      items: {
                        type: "string"
                      }
                    }
                  ]
                },
                content: {
                  type: "array",
                  items: {
                    type: "string"
                  }
                }
              }
            },
            example: {
              type: "array",
              items: {
                type: "string"
              }
            }
          }
        }
      }
    }
  }
}