Safe Haskell	Safe-Inferred
Language	GHC2021

Test.Swagger

Synopsis

existingVersions :: Set Int
internalApis :: Set String
testSwagger :: HasCallStack => App ()
testSwaggerInternalVersionedNotFound :: HasCallStack => App ()
testSwaggerToc :: HasCallStack => App ()
data Swagger
- = SwaggerPublic
- | SwaggerInternal Service
testSwaggerLint :: HasCallStack => Swagger -> App ()

Documentation

existingVersions :: Set Int Source #

internalApis :: Set String Source #

testSwagger :: HasCallStack => App () Source #

See https://docs.wire.com/understand/api-client-perspective/swagger.html

testSwaggerInternalVersionedNotFound :: HasCallStack => App () Source #

testSwaggerToc :: HasCallStack => App () Source #

data Swagger Source #

Constructors

SwaggerPublic
SwaggerInternal Service

Instances

Instances details

TestCases Swagger Source #
Instance details Defined in Test.Swagger Methods mkTestCases :: IO [TestCase Swagger] Source #

testSwaggerLint :: HasCallStack => Swagger -> App () Source #

This runs the swagger linter vacuum.

The reason for adding the linter in the integration tests, and not in the lint job, is that it calls brig for the swagger docs it validates, but no running brig during linting.

There is also a make rule that does this, for convenience in your develop flow. Make sure that brig is running before using the make rule.