Repository navigation
v0.2.0
Description
Smithy API model package with the following built-in functionality:
- When build via
./gradlew buildorgradle 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 GitHub workflow to automatically generate and publish API documentation to GitHub Pages whenever a changes is pushed to the main branch
Changelog
- Extracted msayson/smithy-gh-pages-action GitHub Action that encapsulates logic for generating OpenAPI specs, generating ReDoc API documentation, and deploying API HTML docs to GitHub pages, given the caller has a gradle task that generates the input OpenAPI JSON spec
- Updated generated API HTML doc filepath to
build/docs/docs.html, which deploys to https://www.marksayson.com/consent-management-api-models/docs.html