Alodai docs

sites — Alodai API

Generated from services/sites/src/routes/** and the @mp/shared schemas each handler applies. 8 of 28 operations publish a request schema; the rest are marked unmeasured.

GET
/organizations/{orgId}/sites

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

orgId*string

Response Body

curl -X GET "https://example.com/organizations/string/sites"
Empty
POST
/organizations/{orgId}/sites

Path Parameters

orgId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/organizations/string/sites" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "slug": "string"  }'
Empty
GET
/sites/{siteId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string"
Empty
PATCH
/sites/{siteId}

Path Parameters

siteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/sites/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
DELETE
/sites/{siteId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X DELETE "https://example.com/sites/string"
Empty
GET
/sites/{siteId}/navigation

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/navigation"
Empty
GET
/sites/{siteId}/navigation/{slug}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
slug*string

Response Body

curl -X GET "https://example.com/sites/string/navigation/string"
Empty
PUT
/sites/{siteId}/navigation/{slug}

Path Parameters

siteId*string
slug*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PUT "https://example.com/sites/string/navigation/string" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "items": [      {        "id": "string",        "label": "string",        "type": "page"      }    ]  }'
Empty
GET
/sites/{siteId}/pages

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/pages"
Empty
POST
/sites/{siteId}/pages

Path Parameters

siteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sites/string/pages" \  -H "Content-Type: application/json" \  -d '{    "slug": "string",    "title": "string"  }'
Empty
GET
/sites/{siteId}/pages/{pageId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/string"
Empty
PATCH
/sites/{siteId}/pages/{pageId}

Path Parameters

siteId*string
pageId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/sites/string/pages/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
DELETE
/sites/{siteId}/pages/{pageId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X DELETE "https://example.com/sites/string/pages/string"
Empty
GET
/sites/{siteId}/pages/{pageId}/preview

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/string/preview"
Empty
GET
/sites/{siteId}/pages/{pageId}/preview-public

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/string/preview-public"
Empty
POST
/sites/{siteId}/pages/{pageId}/publish

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X POST "https://example.com/sites/string/pages/string/publish"
Empty
GET
/sites/{siteId}/pages/{pageId}/revisions

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/string/revisions"
Empty
GET
/sites/{siteId}/pages/{pageId}/revisions/{revisionId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
pageId*string
revisionId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/string/revisions/string"
Empty
POST
/sites/{siteId}/pages/{pageId}/revisions/{revisionId}/restore

Path Parameters

siteId*string
pageId*string
revisionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sites/string/pages/string/revisions/string/restore" \  -H "Content-Type: application/json" \  -d '{}'
Empty
GET
/sites/{siteId}/pages/by-path

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/by-path"
Empty
GET
/sites/{siteId}/pages/home

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/pages/home"
Empty
GET
/sites/{siteId}/redirects

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/redirects"
Empty
POST
/sites/{siteId}/redirects

Path Parameters

siteId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/sites/string/redirects" \  -H "Content-Type: application/json" \  -d '{    "fromPath": "string"  }'
Empty
PATCH
/sites/{siteId}/redirects/{redirectId}

Path Parameters

siteId*string
redirectId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/sites/string/redirects/string" \  -H "Content-Type: application/json" \  -d '{}'
Empty
DELETE
/sites/{siteId}/redirects/{redirectId}

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string
redirectId*string

Response Body

curl -X DELETE "https://example.com/sites/string/redirects/string"
Empty
GET
/sites/{siteId}/robots.txt

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/robots.txt"
Empty
GET
/sites/{siteId}/sitemap.xml

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Path Parameters

siteId*string

Response Body

curl -X GET "https://example.com/sites/string/sitemap.xml"
Empty
GET
/sites/resolve

The request shape is unmeasured: this handler applies no @mp/shared schema to its input, so none is published here. Nothing is invented to fill the gap.

Response Body

curl -X GET "https://example.com/sites/resolve"
Empty