search

sul-dlss / cocina-models

Cocina repository data model (implemented in Ruby)
https://sul-dlss.github.io/cocina-models/
3 stars 0 forks source link

Generate markdown from descriptive types #396

Closed mjgiarlo closed 2 years ago

mjgiarlo commented 2 years ago

Fixes #385

Why was this change made? 🤔

This commit adds the ability to generate user-facing documentation about how Cocina validates descriptive types. It is documented in the README and rendered by redoc via being linked to the OpenAPI specification.

How was this change tested? 🤨

CI

mjgiarlo commented 2 years ago

unfortunately, our current openapi validation does not allow a markdown file as a ref. Worth looking into whether redoc/redocly has different tooling (e.g., https://www.npmjs.com/package/@redocly/openapi-cli)? Or we can go with a different implementation that doesn't involve the openapi/redocly infrastructure.

mjgiarlo commented 2 years ago

@justinlittman Even better. Thanks for the assist!