Skip to content

Commit

Permalink
Fix README.md API docs whitespace (#63)
Browse files Browse the repository at this point in the history
  • Loading branch information
jornh authored and feng-tao committed Sep 27, 2019
1 parent f0f3b62 commit 7d8b6cb
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ This way Search service will use production config in production environment. Fo
- PEP 8: Amundsen Search service follows [PEP8 - Style Guide for Python Code](https://www.python.org/dev/peps/pep-0008/ "PEP8 - Style Guide for Python Code").
- Typing hints: Amundsen Search service also utilizes [Typing hint](https://docs.python.org/3/library/typing.html "Typing hint") for better readability.

##API documentation
## API documentation
We have Swagger documentation setup with OpenApi 3.0.2. This documentation is generated via [Flasgger](https://github.com/flasgger/flasgger).
When adding or updating an API please make sure to update the documentation. To see the documentation run the application locally and go to `localhost:5000/apidocs/`.
Currently the documentation only works with local configuration.
Expand Down

0 comments on commit 7d8b6cb

Please sign in to comment.