Skip to content

Commit d850f4b

Browse files
authored
Merge pull request #98 from jberryman/patch-1
Update cabal file to mention OAS, minor cleanup
2 parents 13b7e5d + 7fda83f commit d850f4b

File tree

1 file changed

+8
-6
lines changed

1 file changed

+8
-6
lines changed

servant-swagger.cabal

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,15 @@
11
name: servant-swagger
22
version: 1.1.7
3-
synopsis: Generate Swagger specification for your servant API.
3+
synopsis: Generate a Swagger/OpenAPI/OAS 2.0 specification for your servant API.
44
description:
5-
Swagger is a project used to describe and document RESTful APIs.
6-
Unlike Servant it is language-agnostic and thus is quite popular among developers
7-
in different languages. It also exists for a longer time and has more tools to work with.
5+
Swagger is a project used to describe and document RESTful APIs. The core of the
6+
project is the [OpenAPI Specification (OAS)](https://swagger.io/docs/specification/about/).
7+
This library implements v2.0 of the spec. Unlike Servant it is language-agnostic and thus is
8+
quite popular among developers in different languages. It has also existed for a longer time
9+
and has more helpful tooling.
810
.
9-
This package provides means to generate Swagger specification for a Servant API
10-
and also to partially test whether API conforms with its specification.
11+
This package provides means to generate a Swagger/OAS specification for a Servant API
12+
and also to partially test whether an API conforms with its specification.
1113
.
1214
Generated Swagger specification then can be used for many things such as
1315
.

0 commit comments

Comments
 (0)