GoliathDevelopersGet an API key
Reference/Spacesgenerated from the gateway manifest

publishSpacePage

Publish HTML as a Library Page that opens rendered.

POST/api/v1/callWRITEidempotent · 24 hruns as the key's owner
View as Markdown

Publish HTML as a Library Page that opens rendered (strict page CSP: HTML loading anything from outside Goliath is refused). Lands in destination, else your Pages folder. actorGrn (required): the dev session.

curl https://server.goliathdata.com/api/v1/call \
  -H "Authorization: Bearer $GOLIATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{
    "operationId": "publishSpacePage",
    "variables": {
      "input": {
        "title": "<String>",
        "html": "<String>",
        "actorGrn": "<String>"
      }
    }
  }'
import { GoliathClient } from '@goliath-data/sdk'

const goliath = new GoliathClient({
  apiKey: process.env.GOLIATH_API_KEY!,
  baseUrl: 'https://server.goliathdata.com',
})

const result = await goliath.spaces.publishSpacePage(
  {
    input: {
      title: '<String>',
      html: '<String>',
      actorGrn: '<String>'
    }
  },
  { idempotencyKey: crypto.randomUUID() },
)
const res = await fetch('https://server.goliathdata.com/api/v1/call', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.GOLIATH_API_KEY}`,
    'Content-Type': 'application/json',
    'Idempotency-Key': crypto.randomUUID(),
  },
  body: JSON.stringify({
    operationId: 'publishSpacePage',
    variables: {
      input: {
        title: '<String>',
        html: '<String>',
        actorGrn: '<String>'
      }
    }
  }),
})
const { data, errors } = await res.json()

Variables

The example sends only what the schema requires. Some operations also need one of several optional variables (one filter or another, say); the description above says which.

inputPublishSpacePageInput!required
titleString!required

The page's title; its file name is the title with .html.

htmlString!required

The whole HTML document. It runs under the strict page CSP: nothing loads from outside Goliath.

destinationSpaceDestinationInput

Where it lands; omitted, the key owner's own Pages folder.

creationKeyString

Any unique string, so a retry returns the page it already made.

actorGrnString!required

Who is making it: `DevSession_<sessionId>`, a dev session working for the key's owner.

Every field, all the way down
variables
[
  {
    "name": "input",
    "type": "PublishSpacePageInput!",
    "required": true,
    "description": null,
    "defaultValue": null,
    "fields": [
      {
        "name": "title",
        "type": "String!",
        "required": true,
        "description": "The page's title; its file name is the title with .html.",
        "defaultValue": null
      },
      {
        "name": "html",
        "type": "String!",
        "required": true,
        "description": "The whole HTML document. It runs under the strict page CSP: nothing loads from outside Goliath.",
        "defaultValue": null
      },
      {
        "name": "destination",
        "type": "SpaceDestinationInput",
        "required": false,
        "description": "Where it lands; omitted, the key owner's own Pages folder.",
        "defaultValue": null,
        "fields": [
          {
            "name": "spaceId",
            "type": "ID!",
            "required": true,
            "description": null,
            "defaultValue": null
          },
          {
            "name": "folderId",
            "type": "ID",
            "required": false,
            "description": "Null for the space root.",
            "defaultValue": null
          }
        ]
      },
      {
        "name": "creationKey",
        "type": "String",
        "required": false,
        "description": "Any unique string, so a retry returns the page it already made.",
        "defaultValue": null
      },
      {
        "name": "actorGrn",
        "type": "String!",
        "required": true,
        "description": "Who is making it: `DevSession_<sessionId>`, a dev session working for the key's owner.",
        "defaultValue": null
      }
    ]
  }
]

Response

What comes back under data: a list shows as one entry, and a value as its type.

response shape
{
  "data": {
    "spacesMutation": {
      "publishPage": {
        "id": "<ID>",
        "spaceId": "<ID>",
        "parentId": "<ID>",
        "name": "…",
        "fileType": "…",
        "sizeBytes": 0,
        "currentVersion": {
          "id": "<ID>",
          "versionNumber": 0
        }
      }
    }
  }
}

Errors

Idempotency

Send an Idempotency-Key of 1 to 255 characters. A finished request retried with the same key replays its stored response, marked Idempotency-Replayed: true; one still in flight returns 409 idempotency_conflict. Keys expire after 24 hours. Write without fear →