amenda-api v0.0.1

Utils

List articles

Implement the GET /project/:project_id/articles API endpoint

GET /api/v1/project/:project_id/articles

Success Response

Success-Response:

HTTP/1.1 200 OK
[
  {
    "id": "fc798eff13af1df4a91dc14d26b22c95a90e717d",
    "name": "Article_1.md",
    "type": "blob",
    "path": "Article_1.md",
    "mode": "100644"
  }
]

Success 200

Name Type Description
id String ID of the file
name String Name of the file
type String Type of the file
path String Path of the file
mode String Mode of the file

Ping

Test if the API server is running/responding.

GET /api/v1/ping

Success Response

Success-Response:

HTTP/1.1 200 OK
{"ping":"pong"}

Success 200

Name Type Description
ping String pong

results matching ""

    No results matching ""