Skip to content
StartupBuilder
by startups.studio
by Startups.Studio
Code
Changelog
APICore grammarTemplate

Template routes: extend, promote, upgrade

The Template Verbs extend, promote, upgrade as api.sb routes, with inputs, result, refusals and an example.

Reference for Template, one group of Template routes.

Template.extend

Extend adds a Template to a Startup’s bases, pinned to a Version, so the Startup inherits its definition. Verb page.

Text
POST /{namespace}/templates/{template}/extend

Path: template. Body, as JSON: the other inputs. Emits Template.extended.

Inputs

InputTypeRequiredDescription
templateTemplaterequiredThe Template to inherit.
startupStartuprequiredThe Startup that extends it.

Returns

OutputTypeRequiredDescription
startupStartuprequiredThe Startup with the Template among its bases.
templateTemplaterequiredThe Template extended.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.
A clash between two bases until the Startup settles itrefusedClear what the check names, then call it again.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/extend \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "startup": {
    "$id": "https://api.sb/leaseline.app/startups/startup_l3hr1EnUGY",
    "$type": "Startup",
    "name": "Leaseline"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.extend",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Template.promote

Promote moves one Startup’s refinement into a Template, so every Startup that extends the Template inherits it. Verb page.

Text
POST /{namespace}/templates/{template}/promote

Path: template. Body, as JSON: the other inputs. Emits Template.promoted.

Inputs

InputTypeRequiredDescription
templateTemplaterequiredThe Template that receives the refinement.
startupStartuprequiredThe Startup that holds the refinement.

Returns

OutputTypeRequiredDescription
changeChangerequiredThe Change against the Template.
templateTemplaterequiredThe Template that received the refinement.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/promote \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.promote",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Template.upgrade

Upgrade moves a Startup to a newer Version of a Template it extends, through a Change it can review. Verb page.

Text
POST /{namespace}/templates/{template}/upgrade

Path: template. Body, as JSON: the other inputs. Emits Template.upgraded.

Inputs

InputTypeRequiredDescription
templateTemplaterequiredThe Template to upgrade.
startupStartuprequiredThe Startup that extends it.
versionVersionThe target Version. Defaults to the latest.

Returns

OutputTypeRequiredDescription
changeChangerequiredThe Change that moves the pin.
templateTemplaterequiredThe Template upgraded to.

Refuses when

CheckErrorFixThen call
The key is valid, but its scopes do not allow this operation.forbiddenUse a key whose scopes cover the operation, or ask an owner of the namespace to grant them.None.
The record is not in a state that allows this Verb, so the call is refused.refusedRead the record, run the Verb that moves it to an allowed state, then retry.None.

Example

Terminal
curl -X POST https://api.sb/leaseline.app/templates/template_THRQF1h9uX/upgrade \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"startup":"startup_l3hr1EnUGY"}'
JSON
{
  "api": "https://api.sb/leaseline.app",
  "change": {
    "$id": "https://api.sb/leaseline.app/changes/change_3Ex8uVSOyQ",
    "$type": "Change",
    "status": "Open",
    "base": "version_4HTEMs14G4"
  },
  "template": {
    "$id": "https://api.sb/leaseline.app/templates/template_THRQF1h9uX",
    "$type": "Template",
    "body": "Example body"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Template.upgrade",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

update, delete

Previous

Tenant

Next