Skip to content

v0.1.0

Choose a tag to compare

View all tags
@msayson msayson released this 25 May 22:05
v0.1.0
2ed5902

Smithy API model package with the following built-in functionality:

  • When build via ./gradlew build or gradle wrapper build, automatically:
    • Validate Smithy models
    • Generate consolidated Smithy model JSON file at ./build/smithyprojections/consent-management-api-models/source/model/model.json
    • Generate OpenAPI JSON specification at ./build/smithyprojections/consent-management-api-models/source/openapi/ConsentManagementApi.openapi.json
  • Includes scripts/generate-docs.sh script to support locally generating ReDoc API documentation from the above OpenAPI JSON spec, with prerequisites of installing the yq JSON to YAML conversion utility and the @redocly/cli NPM package
  • Includes GitHub workflow to automatically generate and publish API documentation to GitHub Pages whenever a changes is pushed to the main branch
Assets 2
Loading