Documentation Powered by ReDoc

my-notes-api (2019-07-24T18:47:58Z)

Download OpenAPI specification:Download

Get all notes

Responses

200

200 response

get /notes
/my-notes-dev/notes

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "hasNext": true,
  • "elements":
    [
    ]
}

Create note

Request Body schema: application/json
title
required
string
text
required
string

Responses

200

200 response

400

invalid request

post /notes
/my-notes-dev/notes

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "string",
  • "text": "string"
}

Generate upload link

Request Body schema: application/json
name
required
string

Responses

200

200 response

400

invalid request

post /notes/files
/my-notes-dev/notes/files

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "name": "string"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "link": "string"
}

Generate download link

path Parameters
id
required
string

Responses

200

200 response

get /notes/files/{id}
/my-notes-dev/notes/files/{id}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "link": "string"
}

Edit note

path Parameters
id
required
string
Request Body schema: application/json
title
required
string
text
required
string

Responses

200

200 response

400

invalid request

put /notes/{id}
/my-notes-dev/notes/{id}

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "title": "string",
  • "text": "string"
}

Delete note

path Parameters
id
required
string

Responses

200

200 response

delete /notes/{id}
/my-notes-dev/notes/{id}