Skip to content

Commit

Permalink
Improve documentation #396 (#397)
Browse files Browse the repository at this point in the history
* Update README.md files
  • Loading branch information
pxp9 authored Nov 22, 2021
1 parent e12724d commit 4280a88
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
4 changes: 2 additions & 2 deletions examples/phoenix_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@
This simple Phoenix API Application demonstrates the usage of `open_api_spex`.

- [api_spec.ex](lib/phoenix_app_web/api_spec.ex) contains the outline of the api spec
- [schemas.ex](lib/phoenix_app_web/schemas.ex) conains the request/response schema modules
- [router.ex](lib/phoenix_app_web/router.ex)
- [schemas.ex](lib/phoenix_app_web/schemas.ex) contains the request/response schema modules
- [router.ex](lib/phoenix_app_web/router.ex) contains the plug router


To run this application:
Expand Down
4 changes: 2 additions & 2 deletions examples/plug_app/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This simple Plug API Application demonstrates the usage of `open_api_spex`.

- [api_spec.ex](lib/plug_app/api_spec.ex) contains the outline of the api spec
- [schemas.ex](lib/plug_app/schemas.ex) conains the request/response schema modules
- [schemas.ex](lib/plug_app/schemas.ex) contains the request/response schema modules
- [router.ex](lib/plug_app/router.ex) contains the plug router

To run this application:
Expand All @@ -15,4 +15,4 @@ This simple Plug API Application demonstrates the usage of `open_api_spex`.
mix run --no-halt
```

Navigate to [http://localhost:4000/swaggerui](http://localhost:4000/swaggerui)
Navigate to [http://localhost:4000/swaggerui](http://localhost:4000/swaggerui)

0 comments on commit 4280a88

Please sign in to comment.