VSinerva/freesewing
1
0
Fork 0
Code Activity

chore(markdown): Pages for dev site

Browse source
This commit is contained in:
Joost De Cock 2023-05-22 17:33:03 +02:00
parent dd82285eee
commit 9b7b0bea7e
7 changed files with 73 additions and 19 deletions
Download patch file Download diff file Expand all files Collapse all files

22
markdown/dev/reference/backend/en.md
View file

@ -1,13 +1,27 @@
---
title: FreeSewing Backend
title: Backend REST API
---
This is the reference documentation for the FreeSewing backend REST API.
<Fixme>
<Fixme compact>
This documentation is under construction as we are re-working this API for v3.
</Fixme>
## REST API docs
<ReadMore />
<Tip>
##### Also available as OpenAPI specification
The backend hosts its own auto-generated (Swagger) documentation based
on the OpenAPI specification (v3): [backend3.freesewing.org/docs/
](https://backend3.freesewing.org/docs/)
</Tip>
## About the FreeSewing backend
The FreeSewing backend handles all user data. Prior to version 3 of FreeSewing,
@ -37,10 +51,6 @@ revoke API keys if we feel the use is beyond what we can or want to support.
</Warning>
## REST API docs
<ReadMore />
## Database schema
The database schema for the backend is available in the [prisma.schema][prisma]