franklin-api
v3.3.0
Published
The API is used to render Franklin pages at the edge.
Downloads
2
Readme
Franklin API
The API is used to render Franklin pages at the edge.
Development
npm i && npx wrangler dev
APIs
APIs are deployed at https://core.project-franklin-api.workers.dev
/model
PUT
Index UCM model in Ibiza Content Services and optionally stores it in KV store for page rendering.
| Parameter | Description | |-----------|------| | tenant | Ibiza Content Services tenant name | | preview | Optional: preview index typically used for author previews | | store | Optional (default = false): store HAST model in the KV store for page rendering |
| Header | Description | |---------------|------| | x-api-auth | Content Service Secret |
| Body | Description | |---------------|------| | model | AEM UCM model |
GET
Returns the model by path optimized for page rendering.
| Parameter | Description | |-----------|------| | tenant | Ibiza Content Services tenant name | | path | AEM content path | | preview | Optional: preview index typically used for author previews | | format | Optional: return HAST or UCM (default) format |
POST
Returns models by query optimized for page rendering.
| Parameter | Description | |-----------|------| | tenant | Ibiza Content Services tenant name | | preview | Optional: preview index typically used for author previews | | format | Optional: return HAST or UCM (default) format |
| Body | Description | |---------------|------| | query | UCM GQL query | | variables | UCM GQL variables |
DELETE
Delete the model from Content Services and KV store.
| Parameter | Description | |-----------|------| | tenant | Ibiza Content Services tenant name | | path | AEM content path | | preview | Optional: preview index typically used for author previews |
| Header | Description | |---------------|------| | x-api-auth | Content Service Secret |