README.md

TEA Specification

TEA domain objects

• TEA Product

TEA Schema

The domain objects above are described in the JSON schema is tea.schema.yaml

TEA OpenAPI Spec

The OpenAPI 3.1 specification for the Transparency Exchange API is available in openapi.json.

• Generating API Clients from OpenAPI Spec

Generating API Clients from OpenAPI Spec

We use the OpenAPI Generator with configuration per language/framework in the generators folder. An example is:

docker run \
    --rm \
    -v "$(PWD):/local" \
    openapitools/openapi-generator-cli \
    batch --clean /local/spec/generators/typescript.yaml

Preview Specs

Fire up the swagger-ui with Docker from the root of the repository:

docker run \
    -p 8080:8080 \
    -e SWAGGER_JSON=/koala/spec/openapi.json \
    -v $(pwd):/koala swaggerapi/swagger-ui

And browse to http://localhost:8080.