public/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2026-01-09 06:49:39 +00:00
Code Issues Releases Wiki Activity

sismics docs -> teedy

Browse Source
This commit is contained in:
Benjamin Gamard
2019-02-12 13:57:54 +01:00
parent a86af9736b
commit 868a74c184
48 changed files with 118 additions and 119 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs-web/src/main/webapp/header.md
View File

@@ -1,4 +1,4 @@
The web client and Android application for **Sismics Docs** are only examples
The web client and Android application for **Teedy** are only examples
of what is possible with the provided REST API. Everything you see in those apps are
accessible using the API.
@@ -6,8 +6,8 @@ This documentation is divided in two parts. The first will get you started on es
steps like authentication and the second part is a full reference of every endpoints.
## API URL
The base URL depends on your server. If your instance of Docs is accessible through
`https://docs.mycompany.com`, then the base API URL is `https://docs.mycompany.com/api`.
The base URL depends on your server. If your instance of Teedy is accessible through
`https://teedy.mycompany.com`, then the base API URL is `https://teedy.mycompany.com/api`.
## Verbs and status codes
The API uses restful verbs.