Skip to content

Templates API ​

Los endpoints Template gestionan el root template del project, groups, topics y rules.

GET /api/projects/:fullname/templates ​

Devuelve los templates del project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: ProjectTemplate[].

GET /api/projects/:fullname/template ​

Devuelve el root template del project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: ProjectTemplate, o not found.

POST /api/projects/:fullname/templates ​

Crea un template/group para el project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload:

CampoObligatorioDescripción
projectSíProject fullname.
schemaSíTemplate inputs schema.
groupsSíArray de template groups.
topicsSíArray de topics.
rulesSíArray de rules que vinculan topics con triggers.
meta.titleSíTemplate title.
meta.descriptionSíTemplate description.

Respuesta: ProjectTemplate.

GET /api/projects/:fullname/templates/:id ​

Devuelve un template.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.
idPathTemplate id.

Payload: ninguno.

Respuesta: ProjectTemplate.

PUT /api/projects/:fullname/templates/:id ​

Actualiza un template.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.
idPathTemplate id.

Payload: misma estructura que POST /api/projects/:fullname/templates.

Respuesta: ProjectTemplate.

DELETE /api/projects/:fullname/templates/:id ​

Elimina un template.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.
idPathTemplate id.

Payload: ninguno.

Respuesta: OperationResult.

Detalles del payload de template ​

groups ​

Cada group:

CampoObligatorioDescripción
nameSíGroup name.
meta.titleSíTítulo visible.
meta.descriptionSíDescripción.

topics ​

Cada topic:

CampoObligatorioDescripción
nameSíTopic name.
groupSíGroup name/fullname.
selectedByDefaultSíIndica si el topic se selecciona por defecto en el subscription wizard.
meta.titleSíTítulo visible.
meta.descriptionNoDescripción.

rules ​

Cada rule:

CampoObligatorioDescripción
idSíRule id.
triggerSíTrigger fullname.
topicSíTopic name.
inputsNoStatic input mapping o null.
policyNo`{ type: "filter"
conditionsNoConditions object o null.
deprecatedSíIndica si la rule está deprecated.
requiredValuesSíInput keys requeridos por esta rule.