API reference

Create a demo page

Create a placeholder documentation page.

POST

Create a demo page

Create a placeholder documentation page.

POST /v1/demo-pages

Generated from examples/openapi.json. This is a schema reference stub. Live request execution is not enabled.

Request body

Request example

Request

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/DemoPageCreate"
      },
      "example": {
        "title": "Install the CLI",
        "body": "Run npm install -g example-cli."
      }
    }
  }
}

Responses

201HTTP response

The demo page was created.

400HTTP response

The request body was invalid.

Schemas

Response example

Component

{
  "DemoPage": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "slug": {
        "type": "string"
      },
      "title": {
        "type": "string"
      },
      "status": {
        "type": "string",
        "enum": [
          "draft",
          "published"
        ]
      }
    },
    "required": [
      "id",
      "slug",
      "title",
      "status"
    ]
  },
  "DemoPageCreate": {
    "type": "object",
    "properties": {
      "title": {
        "type": "string"
      },
      "body": {
        "type": "string"
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "required": [
      "title",
      "body"
    ]
  }
}