firezone

mirror of https://github.com/outbackdingo/firezone.git synced 2026-01-27 10:18:54 +00:00

Files

Andrew Dryga 6003ea7e26 Generate API docs from tests and Phoenix Controller docs (#1286 )

1. The test data is taken from tests, you can override attributes by
adding keyword params to `doc` macro;
2. Additionally, you can add a section title using a `@moduledoc` in a
controller and a controller action title using `@doc` on a controller
function. (It will be added to all instances of its usage).
3. To make parameters nice a helper was added to build it using
`DocHelper`, you can find an example in UserController.

Overall, the code is messy, I'll need to revisit it, but was doing it in
a rush so hope it's good enough for v0.

Results you can see at https://firezone.docs.apiary.io/.

To generate it locally run `DOC=1 mix test
test/fz_http_web/controllers/json`.

Co-authored-by: Jamil Bou Kheir <jamilbk@users.noreply.github.com>

2023-01-12 22:40:21 -08:00

docker_build.yml

Build docker image in build workflow; Update automatic install to use Docker (#983 )

2022-09-29 08:20:32 -05:00

docker_publish.yml

Bump akhilerm/tag-push-action from 2.0.0 to 2.1.0 (#1152 )

2022-11-28 08:27:51 -08:00

omnibus_build.yml

[Supercedes #1255 ] Replace npm with yarn (#1256 )

2022-12-31 15:44:23 -06:00

omnibus_publish.yml

Bump andstor/file-existence-action from 1 to 2 (#1080 )