Skip to content

Latest commit

 

History

History
18 lines (14 loc) · 875 Bytes

README.md

File metadata and controls

18 lines (14 loc) · 875 Bytes
Raw

Semoasa 0.1.0 template parameters

Semoasa (Specification Extension Metadata for OAS Annotations) is a machine-readable format for extensions to Swagger/OpenAPI 2.0 and 3.0 specifications.

'main' template

  • api - the top-level Semoasa document
  • header - the front-matter of the Slate/Shins markdown document
  • options - the options passed to the renderer, includes defaults
  • templates - the doT templates object
  • oas2_descs - a map of OASv2 objects and descriptions
  • oas3_descs - a map of OASv3 objects and descriptions
  • utils - an object containing utility functions
    • yaml - yaml instance
    • schemaToArray - converts a schema object to a flat list of properties
    • getSample - returns an example based on a schema object
    • linkCase - helper function which returns camelCased object names