/stix-swagger

:bowtie: Generate swagger docs out of thin air for stix.

Primary LanguageTypeScriptMIT LicenseMIT

Stix swagger

Slack Status

A first stab at a stix module that generates swagger docs based on your stix app.

todo

  • Optional fields for Update model (all required are still required)
  • Add query options as parameters (sort, limit, offset, etc)
  • Get actual error format from ResponseService (fake a response to get layout)
  • Create config for default swagger doc values.
  • Allow for additional meta to be provided (decorator, or last arg on the route)
  • Implement authentication types
  • SwaggerMeta.compose(Entity, { auth: 'jwt' })
  • Add link to stix-wetland docs explaining querying options
  • Allow for fields to be marked as optional (createdAt and the likes)

License

MIT.