View Source Contributing


Open an issue

If you've found a bug or would like to discuss a new feature, start by opening an issue. Where possible, please refer to the relevant sections of the Open API Specification 3.0 or JSON Schema Specification:


Send a Pull Request

Link your pull request to the issue opened earlier, eg fixes #123. Please be patient as maintainers are generally volunteering their time to support the project 🙂


Get Help

You can ask for help using OpenApiSpex by:


Releasing (Maintainers Only)

To ship a release to, complete the following checklist:

  • Confirm the project builds and all tests pass on your machine mix clean; mix test
  • If possible, look for regressions by testing master against a project that uses :open_api_spex.
  • Confirm the docs build successfully and do not contain obvious formatting errors mix docs; open doc/index.html
  • Review the file, adding a line for each pr / issue and a larger description for significant changes.
  • Update the @version attribute in mix.exs
  • Update the Installation section of the file with the new version (for minor and major releases)
  • Commit and tag the master branch with the version and a leading v, eg: v3.14.15
  • Push master branch to open_api_spex repo
  • Push package to Hex: mix hex.publish
  • Add a release announcement to the Elixir Forum thread
  • Add a release announcement to the #open_api_spex channel in the Elixir Slack workspace