Skip to content

Templates API

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

GET /api/v2/projects/:fullname/templates

Devuelve los templates del project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: ProjectTemplate[].

GET /api/v2/projects/:fullname/template

Devuelve el root template del project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload: ninguno.

Respuesta: ProjectTemplate, o not found.

POST /api/v2/projects/:fullname/templates

Crea un template/group para el project.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.

Payload:

CampoObligatorioDescripción
projectProject fullname.
schemaTemplate inputs schema.
groupsArray de template groups.
topicsArray de topics.
rulesArray de rules que vinculan topics con triggers.
meta.titleTemplate title.
meta.descriptionTemplate description.

Respuesta: ProjectTemplate.

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

Devuelve un template.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.
idPathTemplate id.

Payload: ninguno.

Respuesta: ProjectTemplate.

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

Actualiza un template.

Argumentos:

ArgumentoUbicaciónDescripción
fullnamePathProject fullname.
idPathTemplate id.

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

Respuesta: ProjectTemplate.

DELETE /api/v2/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
nameGroup name.
meta.titleTítulo visible.
meta.descriptionDescripción.

topics

Cada topic:

CampoObligatorioDescripción
nameTopic name.
groupGroup name/fullname.
selectedByDefaultIndica si el topic se selecciona por defecto en el subscription wizard.
meta.titleTítulo visible.
meta.descriptionNoDescripción.

rules

Cada rule:

CampoObligatorioDescripción
idRule id.
triggerTrigger fullname.
topicTopic name.
inputsNoStatic input mapping o null.
policyNo`{ type: "filter"
conditionsNoConditions object o null.
deprecatedIndica si la rule está deprecated.
requiredValuesInput keys requeridos por esta rule.