JSON Schema


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.

API Blueprint

Notes

Get a note

Gets a single note by its unique identifier.

REQUEST

RESPONSE

Headers
Content-Type application/json
200 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"
            }
        }
    }
}

                      

Update a note

Modify a note’s data using its unique identifier. You can edit the title, content, and tags.

REQUEST

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
}

                        

RESPONSE

Headers