swagger2

Swagger 2.0 data model https://github.com/GetShopTV/swagger2

Version on this page:2.1.3
Stackage Nightly 2017-10-13:2.1.6
LTS Haskell 9.9:2.1.6
Latest on Hackage:2.1.6
BSD3 licensed by Nickolay Kudasov
Maintained by nickolay@getshoptv.com

Module documentation for 2.1.3

There are no documented modules for this package.

swagger2

Join the chat at https://gitter.im/haskell-swagger2/Lobby

Hackage Build Status Stackage LTS Stackage Nightly

Swagger 2.0 data model.

The original Swagger 2.0 specification is available at http://swagger.io/specification/.

Usage

This library is intended to be used for decoding and encoding Swagger 2.0 API specifications as well as manipulating them.

Please refer to haddock documentation.

Some examples can be found in examples/ directory.

Trying out

All generated swagger specifications can be interactively viewed on Swagger Editor.

Ready-to-use specification can be served as JSON and interactive API documentation can be displayed using Swagger UI.

Many Swagger tools, including server and client code generation for many languages, can be found on Swagger's Tools and Integrations page.

Contributing

We are happy to receive bug reports, fixes, documentation enhancements, and other improvements.

Please report bugs via the github issue tracker.

GetShopTV Team

Changes

2.1.6

  • Add ToParamSchema and ToSchema instances for Fixed (see #121) and Natural (see #123);
  • Fix instance for NominalDiffTime (see #121);
  • Fix build for aeson-1.2.2.0 (see #125).

2.1.5

  • Type error by default when deriving Generic-based instances for mixed sum types (see #118);
  • Adjust allOf to accept referenced schemas (see #119);
  • Add instances for Identity (see #116);
  • Add Gitter chat badge (see #114).

2.1.4.1

  • GHC-8.2 support (see #95, #106 and #108);
  • Documentation corrections (see #105);
  • Allow generics-sop-0.3 (see #102);
  • Fix ToSchema example in docs (see #104).

2.1.4

  • Add liftDeclare (see #100);
  • Add MonadDeclare instances for all monad transformers (see #100).

2.1.3

  • Add UUID instances (see #81).
  • Add TypeError ToSchema and ToParamSchema ByteString instances (see #78)
  • Improve documentation for generic sum type instance derivation (see #75)
  • Compile warning free (see #82)

2.1.2.1

  • Bug fix previous release

2.1.2

  • Minor changes: * Support aeson-1.0.0.0 (see #70).

2.1.1

  • Minor changes: * Proper Schema examples for Char, Day, LocalTime, ZonedTime and UTCTime.

2.1

  • Major changes: Use InsOrdHashMap to preserve insertion order for endpoints and definitions (see #56); Add support for GHC 8.0 (see #65).

2.0.2

  • Fixes: Fix additionalProperties to allow references; Fix ToSchema instances for Map and HashMap (prevent infinite recursion for recursive values).

2.0.1

  • Fixes:
    • Re-export Pattern synonym from Data.Swagger;
    • Documentation fixes.

2.0

  • Major changes:
    • GHC 7.8 support (see #49);
    • Switch to classy field lenses (see #41);
    • Add Data.Swagger.Schema.Validation (see #18);
    • Add Data.Swagger.Operation with helpers (see #50);
    • Add IsString instances for some types (see #47);
    • Add helpers to sketch Schema from JSON (see #48).
  • Minor changes:
    • Make NamedSchema a data rather than type (see #42);
    • Change Definitions to Definitions Schema;
    • Add schema templates for "binary", "byte" and "password" formats (see 63ed597);
    • Add Monoid instance for Contact;
    • Change tags to be Set rather than list.
  • Fixes:
    • Fix schema for () and nullary constructors (see ab65c4a);
    • Fix Operation FromJSON instance to allow missing tags and parameters properties.

1.2.1

  • Minor changes:
    • Change _SwaggerItemsPrimitive type from a Prism' to a more restrictive Review-like Optic'.
  • Fixes:
    • Fix build for GHC 8.0-rc1.

1.2

  • Minor changes (see #36): Change default ToSchema instance for unit data types (i.e. types with one nullable constructor like data Unit = Unit): now these types are treated like sum types with only one alternative; Add generic ToParamSchema instance for unit data types; * Add items: [] to schema for () (making it a valid schema).

  • Fixes:
    • Do not omit items: [] from Schema JSON;
    • Do not generate unused definitions for nested newtypes (see #38).

1.1.1

  • Fixes:
    • CollectionFormat Param -> CollectionFormat ParamOtherSchema; this change was necessary after putting CollectionFormat to SwaggerItems.

1.1

  • Major changes:
    • Put CollectionFormat in one place (see 3cc860d).
  • Minor changes:
    • Use Swagger formats for Int32, Int64, Float, Double, Day and ZonedTime (see #32);
    • Export HeaderName, TagName, HttpStatusCode type synonyms;
    • Add ToParamSchema instances for [a], Set a and HashSet a;
    • Add Monoid instances for Header and Example.
  • Fixes:
    • Use overwrite strategy for HashMap SwaggerMonoid instances by default.

1.0

  • Major changes:
    • Add Data and Typeable instances for Data.Swagger types;
    • Merge ParamType/ItemsType/SchemaType into SwaggerType GADT;
    • Merge collection format types into CollectionFormat GADT;
    • Introduce SwaggerItems GADT, replacing Items and SchemaItems in ParamSchema (see #24);
    • Move type, format and items fields to ParamSchema (former SchemaComon);
    • Prepend reference path automatically (see commit 49d1fad) and thus remove "#/definitions/" from user code, leaving much clearer Reference "Name";
    • Change Data.Swagger.Schema (see #19):
      • Change the only method of ToSchema to declareNamedSchema which should produce a NamedSchema along with a list of schema definitions used to produce it;
      • Add declareSchema, declareSchemaRef;
      • Replace genericTo* helpers with genericDeclare* helpers;
      • Add paramSchemaTo[Named]Schema helpers to facilitate code reuse for primitive schemas;
      • Add helpers for inlining Schema references dynamically (see #23);
    • Add ToParamSchema class (see #17) with
      • generic default implementation and
      • instances for some base types compliant with http-api-data instances;
    • Add Data.Swagger.Declare module with
      • DeclareT monad transformer;
      • MonadDeclare type class;
      • various helpers;
    • Rename parameter-related types:
      • Parameter -> Param;
      • ParameterSchema -> ParamAnySchema;
      • ParameterOtherSchema -> ParamOtherSchema;
      • ParameterLocation -> ParamLocation;
      • SchemaCommon -> ParamSchema;
      • parameter* fields renamed to param* fields;
      • schemaCommon* fields renamed to paramSchema* fields;
      • HasSchemaCommon -> HasParamSchema.
  • Minor changes:
    • Replace TH-generated JSON instances with Generic-based (see #25);
    • Drop template-haskell dependency;
    • Omit empty array/object properties from toJSON output (#22);
    • Remove minLength property from schemas for time types;
    • Move SchemaOptions to Data.Swagger.SchemaOptions;
    • Remove useReferences from SchemaOptions (see #23);
    • Place all internal submodules under Data.Swagger.Internal;
    • Better documentation (see #26).

0.4.1

  • Fixes:
    • Use PackageImports for Data.HashSet to avoid test failure on stackage (see #15);
    • Add an upper version bound for aeson due to aeson-0.10.0.0 bug (see bos/aeson#293);
    • Switch to Cabal-based multi GHC Travis config.

0.4

  • Remove Swagger/swagger prefixes;
  • Add ToSchema type class with default generic implementation;
  • Add configurable generic ToSchema helpers;
  • Add doctest test suite;
  • Fixes:
    • Fix HasSchemaCommon instance for Schema;
    • Change minimum, maximum and multipleOf properties to be any number, not necessarily an integer;
    • Fix all warnings.

0.3

  • Fixes:
    • Fix SwaggerMonoid Text instance;
    • Wrap Bool in Maybe everywhere;
    • These changes make all Data.Swagger Monoid instances obey monoid laws (previously right identity law was broken by some instances).

0.2

  • Add Data.Swagger.Lens;
  • Support references;
  • Fixes:
    • Fix FromJSON SwaggerHost instance;
    • Add missing Maybes for field types;
    • Decode petstore swagger.json successfully.
comments powered byDisqus