All Versions
16
Latest Version
Avg Release Cycle
95 days
Latest Release
870 days ago
Changelog History
Page 1
Changelog History
Page 1
-
v0.8.3 Changes
January 15, 2021- fix broken param parsing caused from Plug 1.11.0
- allow swagger ui validator url to be customized
- validatorUrl replaced with configUrl
- warning messages fixed for Elixir 1.11
- dialyxir, plug, ex_json_schema and other dependencies are updated to the latests versions
-
v0.8.2 Changes
December 12, 2019- Add support for Phoenix ~> 1.4.9
- Ability to configure json library e.g. config
:phoenix_swagger, json_library: Jason
- Improvements in SwagerUI Plug
- Update dependencies
- Bug fixes
-
v0.8.1 Changes
July 05, 2018- Fix for crash on non-GET requests
- Fix compilation error running
mix phx.swagger.generate
beforemix compile
- Validate number type in query parameter
- Add
id
andtype
properties to theincluded
-items schema - Add
Schema.nullable
function to set thex-nullable
property - Add
nullable:
option toJsonSchema.relationship
function - Handle
x-nullable
schemas inSchemaTest
- Add
deprecated
flag for operations
-
v0.8.0 Changes
March 13, 2018- Passing module names and output path as mix task parameters is no longer supported.
- Inferring default module names from mix project is no longer supported.
Swagger file outputs, router module and optional endpoint module must now be specified in application config:
config :my_app, :phoenix_swagger, swagger_files: %{ "priv/static/swagger.json" => [router: MyAppWeb.Router, endpoint: MyAppWeb.Endpoint], # additional swagger files here }
phoenix_swagger
can now be run as a mix compiler task, ensuring that the generated swagger is kept in sync with code, and enabling live reloading.compilers: [:phoenix, :gettext, :phoenix_swagger] ++ Mix.compilers
The HTTP verb and path can now be inferred from the phoenix router:
swagger_path :show do get "/api/users/{id} description "Gets a user by ID" response 200, "OK", Schema.ref(User) end
Can now be written without the
get
:swagger_path :show do description "Gets a user by ID" response 200, "OK", Schema.ref(User) end
Note that if your controller contains a
delete/2
function (such as when using theresources
convention), then callingdelete/2
fromPhoenixSwagger.Path
will now cause a compilation error. To avoid this problem, include the full module (shown below), or simply remove the line and allow the verb and path to be inferred from the route:swagger_path(:delete) do PhoenixSwagger.Path.delete "/api/users/{id}" summary "Delete User" end
-
v0.7.1 Changes
November 09, 2017- Use the :load_from_system_env Endpoint config flag to detect dynamic host and port configuration
-
v0.7.0 Changes
November 09, 2017- Minor fix that supports the Phoenix 1.3 namespacing, where it is {Project}Web instead of {Project}.Web.
- Add support for has_many relationships for JSON-API resource schemas
- Upgrade to swagger-ui 3.1.7
- Tests for nested and non-nested required parameters for
PhoenixSwagger.Plug.Validate
. - Decode parameter names using
Plug.Conn.Query.decode
and walkconn.params
to find the nested param asconn.params
is already nested whileparameter["name"]
is not when received byPhoenixSwagger.Plug.Validate.validate_query_params/2
.
-
v0.6.4 Changes
July 15, 2017- Adds support to enable security by endpoint
PhoenixSwagger.Plug.Validate
sets response content type on error toapplication/json
PhoenixSwagger.Plug.Validate
accepts:validation_failed_status
option, defaults to 400- Example application includes usage of validator
-
v0.6.3 Changes
June 17, 2017- Adds support for custom Endpoint module names by passing
--endpoint
- Added patch request support
- Adds support for custom Endpoint module names by passing
-
v0.6.2 Changes
May 09, 2017- fix path assignation of a swagger specification file in UI plug
- add
disable_validator
option to disable/enable validation of a swagger schema.
-
v0.6.1 Changes
May 09, 2017- Provide default host and port when generating swagger host config
- Suppress host config when dynamic hostname or port are used