Template Registry API (0.10.0)

Download OpenAPI specification:Download

templates

Add a template to Template Registry for a further verification.

Authorizations:

createAndUpdateTemplateAuth

Request Body schema: application/json
required

name required	string The name of the template on npmjs.com
author	string The name of the template's author on npmjs.com
createdBy	string The name of the user who created the template
updatedBy	string The name of the user who last updated the template
description	string A description of the template
adobeRecommended	boolean Whether the template is recommended by Adobe
latestVersion	string The version of the template in the semver format
publishDate	string The date the template was published in the ISO 8601 format
	Array of objects non-empty Extension points that a template implements
categories	Array of strings non-empty A list of categories the template belongs to
	Array of objects non-empty A list of Adobe APIs required by the template
	Array of objects non-empty A list of credentials required by the template
runtime	boolean Default: false Whether to add Runtime to App Builder application or not.
event	object event configuration for the template
keywords	Array of strings A list of keywords specified in the packages.json file
status	string Enum: "InVerification" "Approved" "Rejected" "Error" A status of a package in Template Registry. "Error" indicates that an application error occurred.
	Array of objects (CodeSamples) A list of code samples for the template
requestAccessAppId	string Access Platform app id which can be used to request access to services in this template.
isRequestPending	boolean Indicates whether a request for access is already pending for the user in a given org
required	object non-empty A list of locations where the package's code can be found
orgEntitled	boolean Whether the organization is entitled to use the template
userEntitled	boolean Whether the user is entitled to use the template
canRequestAccess	boolean Whether the user can request access to the template
disEntitledReasons	Array of strings A list of reasons why the user is not entitled to use the template

Responses

Request samples

Payload

Content type

application/json

{"name": "@adobe/app-builder-template",
"links": {"github": "https://github.com/adobe/app-builder-template"
}
}

Response samples

200
400

Content type

application/json

{"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf",
"author": "Adobe Inc.",
"name": "@adobe/app-builder-template",
"createdBy": "Lazarus",
"updatedBy": "Lazarus",
"description": "AppBuilder template",
"adobeRecommended": true,
"latestVersion": "1.0.10",
"publishDate": "2022-04-20T19:54:41.495Z",
"extensions": [{"extensionPointId": "dx/excshell/1"
}
],
"categories": ["graphql-mesh"
],
"apis": [{"code": "AdobeAnalyticsSDK",
"credentialType": "string",
"flowType": "string"
}
],
"credentials": [{"type": "OAUTH_SERVER_TO_SERVER",
"flowType": "ENTP"
}
],
"runtime": false,
"event": { },
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"codeSamples": [{"language": "javascript",
"link": "https://developer-stage.adobe.com/codeSample.zip"
}
],
"requestAccessAppId": "FireflySDKEnterprise1",
"isRequestPending": "true",
"links": {"npm": "https://www.npmjs.com/package/@adobe/app-builder-template",
"github": "https://github.com/adobe/app-builder-template",
"consoleProject": "https://developer-stage.adobe.com/console/projects/<project-id>"
},
"orgEntitled": true,
"userEntitled": true,
"canRequestAccess": true,
"disEntitledReasons": ["USER_MISSING_DEV_ROLE",
"ORG_MISSING_FIS",
"USER_MISSING_PRIVATE_BETA",
"USER_MISSING_PUBLIC_BETA"
],
"_links": {"self": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"next": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"review": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
}
}
}

Return a list of templates matching a specified criteria.

query Parameters

names	string Filter by template names. A comma-delimited list of template names (npm package names).
categories	string Filter by template categories. A comma-delimited list of template categories.
apis	string Filter by template APIs. A comma-delimited list of template APIs.
extensions	string Filter by template extension points. A comma-delimited list of template extension points.
events	string Filter by template events. It supports "empty" (?events=) and "any" (?events=) filters for now. The "empty" filter (?events=) returns templates that do not have the "event" property set. The "any" (?events=) filter returns templates that do have the "event" property set.
runtime	string Enum: "true" "false" "*" Is Runtime required or not.
statuses	string Filter by template statuses.
adobeRecommended	boolean Indicates templates featured by Adobe.
size	integer Default: 10 Enum: 10 25 50 A number of items to return.
cursor	string We'll use a forward-only cursor-based pagination (also known as an infinite scrolling). A value is a BASE64 encoded encrypted string.
orderBy	string A query parameter used for sorting. The value of the orderBy parameter contains a comma-separated list of expressions used to sort the items. The expression MAY include the suffix "asc" for ascending or "desc" for descending, separated from the property name by a space. If "asc" or "desc" is not specified, the service MUST order by the specified property in ascending order. Sub-sorts can be specified by a comma-separated list of property names with an OPTIONAL direction qualifier.

Responses

Response samples

200
400

Content type

application/json

{"items": [{"id": "f62f3381-592a-41a3-b936-ef953abd0155",
"author": "Adobe Inc.",
"name": "@adobe/app-builder-template",
"description": "AppBuilder template",
"adobeRecommended": true,
"latestVersion": "1.0.10",
"publishDate": "2022-04-22T04:17:28.643Z",
"categories": ["graphql-mesh"
],
"apis": [{"code": "Runtime"
}
],
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"links": {"npm": "https://www.npmjs.com/package/@adobe/app-builder-template",
"github": "https://github.com/adobe/app-builder-template"
},
"_links": {"self": {"href": "https://template-registry-api.tbd/apis/v1/templates/@adobe/app-builder-template"
}
}
},
{"id": "3e3aee0b-539e-43b1-b47c-0a69eaf39d6c",
"name": "@company1/app-builder-template",
"status": "InVerification",
"links": {"npm": "https://www.npmjs.com/package/@company1/app-builder-template",
"github": "https://github.com/company1/app-builder-template"
},
"_links": {"self": {"href": "https://template-registry-api.tbd/apis/v1/templates/@company1/app-builder-template"
},
"review": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
}
}
}
],
"_links": {"self": {"href": "https://template-registry-api.tbd/apis/v1/templates?statuses=Approved,InVerification"
},
"next": {"href": "https://template-registry-api.tbd/apis/v1/templates?statuses=Approved,InVerification&cursor=MTIzNDU2Nzg5MA=="
}
}
}

Modify a template to Template Registry.

Authorizations:

createAndUpdateTemplateAuth

path Parameters

templateId

required

string

The id of the template in the database

Request Body schema: application/json
required

Template object to update

updatedBy required	string The name of the user who created the template
description	string A description of the template
latestVersion	string The version of the template in the semver format
categories	Array of strings non-empty A list of categories the template belongs to
adobeRecommended	boolean Whether the template is recommended by Adobe
keywords	Array of strings A list of keywords specified in the packages.json file
status	string Enum: "InVerification" "Approved" "Rejected" "Error" A status of a package in Template Registry. "Error" indicates that an application error occurred.
	Array of objects non-empty Extension points that a template implements
runtime	boolean Default: false Whether to add Runtime to App Builder application or not.
	Array of objects non-empty A list of credentials required by the template
	Array of objects (CodeSamples) A list of code samples for the template
requestAccessAppId	string Access Platform app id which can be used to request access to services in this template.
	Array of objects non-empty A list of Adobe APIs required by the template
	object A link to the Github repository containing the package's source code

Responses

Request samples

Payload

Content type

application/json

{"updatedBy": "Lazarus",
"description": "AppBuilder template",
"latestVersion": "1.0.10",
"categories": ["graphql-mesh"
],
"adobeRecommended": true,
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"extensions": [{"extensionPointId": "dx/excshell/1"
}
],
"runtime": false,
"credentials": [{"type": "OAUTH_SERVER_TO_SERVER",
"flowType": "ENTP"
}
],
"codeSamples": [{"language": "javascript",
"link": "https://developer-stage.adobe.com/codeSample.zip"
}
],
"requestAccessAppId": "FireflySDKEnterprise1",
"apis": [{"code": "AdobeAnalyticsSDK"
}
],
"links": {"github": "https://github.com/adobe/app-builder-template",
"consoleProject": "https://developer-stage.adobe.com/console/projects/<project-id>"
}
}

Response samples

200
400

Content type

application/json

{"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf",
"author": "Adobe Inc.",
"name": "@adobe/app-builder-template",
"createdBy": "Lazarus",
"updatedBy": "Lazarus",
"description": "AppBuilder template",
"adobeRecommended": true,
"latestVersion": "1.0.10",
"publishDate": "2022-04-20T19:54:41.495Z",
"extensions": [{"extensionPointId": "dx/excshell/1"
}
],
"categories": ["graphql-mesh"
],
"apis": [{"code": "AdobeAnalyticsSDK",
"credentialType": "string",
"flowType": "string"
}
],
"credentials": [{"type": "OAUTH_SERVER_TO_SERVER",
"flowType": "ENTP"
}
],
"runtime": false,
"event": { },
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"codeSamples": [{"language": "javascript",
"link": "https://developer-stage.adobe.com/codeSample.zip"
}
],
"requestAccessAppId": "FireflySDKEnterprise1",
"isRequestPending": "true",
"links": {"npm": "https://www.npmjs.com/package/@adobe/app-builder-template",
"github": "https://github.com/adobe/app-builder-template",
"consoleProject": "https://developer-stage.adobe.com/console/projects/<project-id>"
},
"orgEntitled": true,
"userEntitled": true,
"canRequestAccess": true,
"disEntitledReasons": ["USER_MISSING_DEV_ROLE",
"ORG_MISSING_FIS",
"USER_MISSING_PRIVATE_BETA",
"USER_MISSING_PUBLIC_BETA"
],
"_links": {"self": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"next": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"review": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
}
}
}

Get information about a template.

path Parameters

templateId

required

string

The id of the template in the database

Responses

Response samples

200
400

Content type

application/json

{"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf",
"author": "Adobe Inc.",
"name": "@adobe/app-builder-template",
"createdBy": "Lazarus",
"updatedBy": "Lazarus",
"description": "AppBuilder template",
"adobeRecommended": true,
"latestVersion": "1.0.10",
"publishDate": "2022-04-20T19:54:41.495Z",
"extensions": [{"extensionPointId": "dx/excshell/1"
}
],
"categories": ["graphql-mesh"
],
"apis": [{"code": "AdobeAnalyticsSDK",
"credentialType": "string",
"flowType": "string"
}
],
"credentials": [{"type": "OAUTH_SERVER_TO_SERVER",
"flowType": "ENTP"
}
],
"runtime": false,
"event": { },
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"codeSamples": [{"language": "javascript",
"link": "https://developer-stage.adobe.com/codeSample.zip"
}
],
"requestAccessAppId": "FireflySDKEnterprise1",
"isRequestPending": "true",
"links": {"npm": "https://www.npmjs.com/package/@adobe/app-builder-template",
"github": "https://github.com/adobe/app-builder-template",
"consoleProject": "https://developer-stage.adobe.com/console/projects/<project-id>"
},
"orgEntitled": true,
"userEntitled": true,
"canRequestAccess": true,
"disEntitledReasons": ["USER_MISSING_DEV_ROLE",
"ORG_MISSING_FIS",
"USER_MISSING_PRIVATE_BETA",
"USER_MISSING_PUBLIC_BETA"
],
"_links": {"self": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"next": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"review": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
}
}
}

Delete a template from Template Registry.

Authorizations:

deleteTemplateAuth

path Parameters

templateId

required

string

The id of the template in the database

Responses

Response samples

400

Content type

*/*

No sample

Install a template

Authorizations:

bearerAuth

path Parameters

templateId

required

string

The id of the template in the database

Request Body schema: application/json
required

orgId required	string AMS org id
projectName required	string Project name
description	string Project description
required	object Key value pairs of credential metadata like allowed domains, redirect uris etc
	Array of objects Optional field to include license configs to be assigned to a technical account for an individual API

Responses

Request samples

Payload

Content type

application/json

{"orgId": "string",
"projectName": "string",
"description": "string",
"metadata": {"property1": null,
"property2": null
},
"apis": [{"code": "string",
"credentialType": "string",
"flowType": "string",
"licenseConfigs": [{ }
]
}
]
}

Response samples

201
400

Content type

application/json

{"id": "string",
"apiKey": "string",
"orgId": "string",
"technicalAccountId": "string",
"projectId": "string",
"workspaceId": "string",
"subscriptionResult": {"sdkList": ["string"
],
"errorList": ["string"
]
}
}

Get information about a template by organization.

path Parameters

templateName required	string The name of the template on npmjs.com
orgName required	string Organisation name on npmjs.com

Responses

Response samples

200
400

Content type

application/json

{"id": "991f1cf7-8ecc-403c-9f29-1ab8a3beacbf",
"author": "Adobe Inc.",
"name": "@adobe/app-builder-template",
"createdBy": "Lazarus",
"updatedBy": "Lazarus",
"description": "AppBuilder template",
"adobeRecommended": true,
"latestVersion": "1.0.10",
"publishDate": "2022-04-20T19:54:41.495Z",
"extensions": [{"extensionPointId": "dx/excshell/1"
}
],
"categories": ["graphql-mesh"
],
"apis": [{"code": "AdobeAnalyticsSDK",
"credentialType": "string",
"flowType": "string"
}
],
"credentials": [{"type": "OAUTH_SERVER_TO_SERVER",
"flowType": "ENTP"
}
],
"runtime": false,
"event": { },
"keywords": ["aio-app-builder-template",
"aio"
],
"status": "Approved",
"codeSamples": [{"language": "javascript",
"link": "https://developer-stage.adobe.com/codeSample.zip"
}
],
"requestAccessAppId": "FireflySDKEnterprise1",
"isRequestPending": "true",
"links": {"npm": "https://www.npmjs.com/package/@adobe/app-builder-template",
"github": "https://github.com/adobe/app-builder-template",
"consoleProject": "https://developer-stage.adobe.com/console/projects/<project-id>"
},
"orgEntitled": true,
"userEntitled": true,
"canRequestAccess": true,
"disEntitledReasons": ["USER_MISSING_DEV_ROLE",
"ORG_MISSING_FIS",
"USER_MISSING_PRIVATE_BETA",
"USER_MISSING_PUBLIC_BETA"
],
"_links": {"self": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"next": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
},
"review": {"href": "https://github.com/adobe/aio-template-submission/issues/<number>",
"description": "A link to \"Template Review Request\" Github Issue"
}
}
}

Delete a template from Template Registry by organization.

Authorizations:

deleteTemplateAuth

path Parameters

templateName required	string The name of the template on npmjs.com
orgName required	string Organisation name on npmjs.com

Responses

Response samples

400

Content type

*/*

No sample

Template Registry API (0.10.0)

templates

Add a template to Template Registry for a further verification.

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Return a list of templates matching a specified criteria.

query Parameters

Responses

Response samples

Modify a template to Template Registry.

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get information about a template.

path Parameters

Responses

Response samples

Delete a template from Template Registry.

Authorizations:

path Parameters

Responses

Response samples

Install a template

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Get information about a template by organization.

path Parameters

Responses

Response samples

Delete a template from Template Registry by organization.

Authorizations:

path Parameters

Responses

Response samples

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required