Go to file
xxmistacruzxx 49c8d29a79 HUGE COMMIT. Essentially implemented every necessary route. Integrated database functionality. Setup a .env setup. Updated the openapi.yaml. 2024-02-29 19:01:00 -05:00
alttextbackend HUGE COMMIT. Essentially implemented every necessary route. Integrated database functionality. Setup a .env setup. Updated the openapi.yaml. 2024-02-29 19:01:00 -05:00
.env.example HUGE COMMIT. Essentially implemented every necessary route. Integrated database functionality. Setup a .env setup. Updated the openapi.yaml. 2024-02-29 19:01:00 -05:00
.gitignore HUGE COMMIT. Essentially implemented every necessary route. Integrated database functionality. Setup a .env setup. Updated the openapi.yaml. 2024-02-29 19:01:00 -05:00
README.md Added OpenAPI specification. Created template files and methods to complete routes and database functions. Added views to urls.py. Added requirements.txt. 2024-02-08 15:09:34 -05:00
db.sqlite3 Set up Djano REST Framework. Created two routes with GET and POST routes showing the intaking of body inputs. 2023-11-16 15:13:22 -05:00
manage.py Templated routes/views to be fulfilled. Added dotenv functionality. Updated requirements. 2024-02-09 14:11:31 -05:00
openapi.yaml HUGE COMMIT. Essentially implemented every necessary route. Integrated database functionality. Setup a .env setup. Updated the openapi.yaml. 2024-02-29 19:01:00 -05:00
requirements.txt Templated routes/views to be fulfilled. Added dotenv functionality. Updated requirements. 2024-02-09 14:11:31 -05:00

README.md

Alt-Text Backend

ROUTES

/books

GET

FUNCTION

Gets a list of books from database

PARAMS
  • query (string) | ensures book titles must have query as a substring
  • skip (int) | skips skip amount of books from the result
  • limit (int) | limits the amount of books returned to limit
RETURNS
[
  {
    uuid: string,
    title: string,
    description: string,
    cover: string,
  },
  ...
]

POST

FUNCTION

Adds a book to the database and starts initial processing

FIELDS
  • title (string) | desired title for new book
  • description (string) | desired description for new book
  • cover (image_file) | desired cover image for new book
  • file (file[.zip]) | book file (html and images bundled)
RETURNS
{
    uuid: string,
    title: string,
    description: string,
    cover: string,
}

/books/:bookid

GET

PATCH

DELETE

/books/:bookid/export

GET

/books/:bookid/analyze

GET

/books/:bookid/images

GET

PATCH

/books/:bookid/images/:imagesrc

GET

PATCH