Skip to content

14. JSON Schema.md

Latest commit

 

History

History
93 lines (75 loc) · 2.41 KB

14. JSON Schema.md

File metadata and controls

93 lines (75 loc) · 2.41 KB

FORMAT: 1A

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