Skip to content

Releases: Frameio/rolodex

v0.10.1

14 Apr 15:31
1396c5a
Compare
Choose a tag to compare

Changes

  • Strip empty examples from OpenAPI request and response content bodies (see #75)

v0.10.0

13 Aug 17:59
a4e9333
Compare
Choose a tag to compare

Breaking Changes

  • Removes support for Phoenix versions below v1.4.7. See #72

v0.9.0

22 Jul 20:45
e5d1d10
Compare
Choose a tag to compare

Changes

  • Adds Rolodex.Router, a new DSL for defining which routes Rolodex should compile for documentation. This is a breaking change and replaces the filter concept from <= v0.8.1. With this change, Rolodex should work for Phoenix v1.4.7 and greater.

v0.8.1

08 Jun 13:51
e6ce40e
Compare
Choose a tag to compare

Changes

  • Updates doc annotations for multi use controller actions: you can now split by either router path or HTTP method (#66)

v0.8.0

06 Jun 19:42
5f88b25
Compare
Choose a tag to compare

Changes

v0.8.0 includes some extensions to the schema definition and usage syntax.

  • Introduces the concept of schema partials: merges the contents of one schema into the top-level of another. This is particularly useful for shared params used across multiple schemas, such as pagination parameters. (#61)
  • Updates the schema macro DSL within request body and response definitions. Now, you can define a schema inline via the same DSL used within schema modules. This allows you to leverage partials within response or request body schemas, without needing a fully separate schema module to hold the parameters. (#62)
  • We now support passing a schema module ref into the query_params and path_params fields in a doc annotation. The top-level properties of the schema will be serialized into the parameters list when Rolodex compiles your docs.

v0.7.1

03 Jun 19:02
2373638
Compare
Choose a tag to compare

Changes

  • Renames the Open API JSON processor from Processors.Swagger -> Processors.OpenAPI (#58)
  • Support list collection field shorthand in schema fields (#57)
  • Add more OpenAPI string formats (#57)

v0.7.0

22 May 13:09
20874f5
Compare
Choose a tag to compare

Changes

  • Add render groups (#54)

v0.6.1

21 May 13:51
924b66f
Compare
Choose a tag to compare

Changes

  • Adds support for multiple calls to the headers/1 macro in response definitions (#51)

v0.6.0

10 May 19:03
a9a166d
Compare
Choose a tag to compare

Changes

  • Add support for OpenAPI 3 operationId attribute (#47)
  • Add response headers support (#48)

v0.5.1

06 May 18:34
5602d22
Compare
Choose a tag to compare

Changes

  • Refactor Rolodex.Schema.field/3 macro (#42)
  • Serialize route tags (#43)