3.3.0 • Published 2 years ago

franklin-api v3.3.0

Weekly downloads
-
License
MIT
Repository
-
Last release
2 years ago

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.

ParameterDescription
tenantIbiza Content Services tenant name
previewOptional: preview index typically used for author previews
storeOptional (default = false): store HAST model in the KV store for page rendering
HeaderDescription
x-api-authContent Service Secret
BodyDescription
modelAEM UCM model

GET

Returns the model by path optimized for page rendering.

ParameterDescription
tenantIbiza Content Services tenant name
pathAEM content path
previewOptional: preview index typically used for author previews
formatOptional: return HAST or UCM (default) format

POST

Returns models by query optimized for page rendering.

ParameterDescription
tenantIbiza Content Services tenant name
previewOptional: preview index typically used for author previews
formatOptional: return HAST or UCM (default) format
BodyDescription
queryUCM GQL query
variablesUCM GQL variables

DELETE

Delete the model from Content Services and KV store.

ParameterDescription
tenantIbiza Content Services tenant name
pathAEM content path
previewOptional: preview index typically used for author previews
HeaderDescription
x-api-authContent Service Secret
@adobe/aio-cli@franklinjs/plugin-dynamic-imports@rollup/plugin-commonjs@rollup/plugin-node-resolvegraphqlnode-fetchrollup
@infinitebrahmanuniverse/nolb-fran@everything-registry/sub-chunk-1700@zalastax/nolb-fran
3.3.0

2 years ago