Every request and response can have a schema. Below you will find examples using JSON Schema to describe the format of request and response body content.
Gets a single note by its unique identifier.
Parameters | |||
---|---|---|---|
id |
id
abc123
|
Unique identifier for a note |
Headers | |
---|---|
Content-Type | application/json |
application/json
{
"id": "abc123",
"title": "This is a note",
"content": "This is the note content."
"tags": [
"todo",
"home"
]
}
{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"content": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
Modify a note's data using its unique identifier. You can edit the title
,
content
, and tags
.
Parameters | |||
---|---|---|---|
id |
id
abc123
|
Unique identifier for a note |
Headers | |
---|---|
Content-Type | application/json |
application/json
{
"title": "This is another note",
"tags": [
"todo",
"work"
]
}
{
"type": "object",
"properties": {
"title": {
"type": "string"
},
"content": {
"type": "string"
},
"tags": {
"type": "array",
"items": {
"type": "string"
}
}
},
"additionalProperties": false
}