Tutorial

FORMAT: 1A

Level 1 Header

Level 2 Header

Level 3 Header

```ruby
# This is some Ruby code!
```

```python
# This is some Python code!
```
Tabla encabezado 1 Table Header 2 Table Header 3
Fila 1 col 1 Fila 1 col 2 Fila 1 col 3
Fila 2 col 1 Fila 2 col 2 Fila 2 col 3

This text is bold, this is italic, this is an inline code block.

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 [/notes/{id}]

  • Parameters
    • id: abc123 (required) – Unique identifier for a note

Get a note [GET]

Gets a single note by its unique identifier.

  • Response 200 (application/json)
    • Body
      {
          "id": "abc123",
          "title": "This is a note",
          "content": "This is the note content."
          "tags": [
              "todo",
              "home"
          ]
      }
      
    • Schema
      {
          "type": "object",
          "properties": {
              "id": {
                  "type": "string"
              },
              "title": {
                  "type": "string"
              },
              "content": {
                  "type": "string"
              },
              "tags": {
                  "type": "array",
                  "items": {
                      "type": "string"
                  }
              }
          }
      }
      

Update a note [PATCH]

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

  • Request (application/json)
    • Body
      {
          "title": "This is another note",
          "tags": [
              "todo",
              "work"
          ]
      }
      
    • Schema
      {
          "type": "object",
          "properties": {
              "title": {
                  "type": "string"
              },
              "content": {
                  "type": "string"
              },
              "tags": {
                  "type": "array",
                  "items": {
                      "type": "string"
                  }
              }
          },
          "additionalProperties": false
      }
      
  • Response 204