updated documentation with new endpoints

This commit is contained in:
Ben
2018-09-05 22:05:13 +01:00
parent a253fa4280
commit f19d1588b9
2 changed files with 30 additions and 1 deletions

View File

@@ -96,3 +96,32 @@ Expected response:
"token": yourGeneratedToken
}
]
## POST /unauth/permanote
Request body:
{
"text": textOfNote
}
The request will be processed by the server if a text feild is present, then the server will store and generate an endpoint for the permalink.
Expected response:
"data": [
{
"status": "Resource created",
"note": {
"uid": uidAssignedToNote,
"endpoint": "/api/note/generatedEndpoint",
"text": inputedText
}
}
]
## GET /note/:endpoint
Request args:
:endpoint
If that note exists, the endpoint will simply return the text assigned to that endpoint or a 404 error.