Skip to content

Commit

Permalink
backend: docs: populate initial API endpoints
Browse files Browse the repository at this point in the history
  • Loading branch information
ericswpark committed Feb 23, 2024
1 parent 8b56b1f commit 3f156ea
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 16 deletions.
19 changes: 19 additions & 0 deletions backend/docs/api/v0/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# API - v0

Warning: the v0 endpoints can and will change at any time!

## Book search

`host/api/v0/books/search`

You must supply a search query of name `title`.

Example query: `host/api/v0/books/search?title=turtle+in+paradise`

## Author search

`host/api/v0/author/search`

You must supply a search query of name `name`.

Example query: `host/api/v0/author/search?name=john+green`
18 changes: 2 additions & 16 deletions backend/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,3 @@
# Welcome to MkDocs
# Backend documentation

For full documentation visit [mkdocs.org](https://www.mkdocs.org).

## Commands

* `mkdocs new [dir-name]` - Create a new project.
* `mkdocs serve` - Start the live-reloading docs server.
* `mkdocs build` - Build the documentation site.
* `mkdocs -h` - Print help message and exit.

## Project layout

mkdocs.yml # The configuration file.
docs/
index.md # The documentation homepage.
... # Other markdown pages, images and other files.
Use the links in the navigation bar!

0 comments on commit 3f156ea

Please sign in to comment.