Apps, Actions, Blueprints e Types API

Estes endpoints descrevem o builder/registry layer: apps, actions, blueprints e shared types. São usados para service integrations e definições reutilizáveis de resource/action.

Apps

GET /api/apps

Devolve apps.

Argumentos:

Argumento	Localização	Descrição
project	Query	Filtro opcional por project fullname.
workspace	Query	Filtro opcional por workspace fullname.

Payload: nenhum.

Resposta: AppView[].

GET /api/apps/:fullname

Devolve uma app.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: AppView.

PUT /api/apps/:fullname

Cria ou atualiza uma app.

Payload:

Campo	Obrigatório	Descrição
name	Sim	App name.
fullname	Sim	App fullname.
project	Sim	Project fullname.
workspace	Sim	Workspace fullname.
url	Sim	App URL.
tags	Não	Tags.
labels	Não	Labels.

Resposta: AppView.

DELETE /api/apps/:fullname

Elimina uma app.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: OperationResult.

Actions

GET /api/actions

Devolve actions.

Argumentos:

Argumento	Localização	Descrição
project	Query	Filtro opcional por project.
workspace	Query	Filtro opcional por workspace.

Payload: nenhum.

Resposta: ActionView[].

GET /api/actions/:fullname

Devolve uma action.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: ActionView.

PUT /api/actions/:fullname

Cria ou atualiza uma action.

Payload:

Campo	Obrigatório	Descrição
name	Sim	Action name.
fullname	Sim	Action fullname.
project	Sim	Project fullname.
workspace	Sim	Workspace fullname.
backend	Sim	Action backend definition.
values	Sim	Action values schema.
overrides	Sim	Campos que a action pode sobrescrever.
tags	Não	Tags.
labels	Não	Labels.
meta	Sim	Action metadata.

Resposta: ActionView.

DELETE /api/actions/:fullname

Elimina uma action.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: OperationResult.

Blueprints

GET /api/blueprints

Devolve blueprints.

Argumentos:

Argumento	Localização	Descrição
app	Query	Filtro opcional por app fullname.
project	Query	Filtro opcional por project fullname.
workspace	Query	Filtro opcional por workspace fullname.

Payload: nenhum.

Resposta: BlueprintView[].

GET /api/blueprints/:fullname

Devolve um blueprint.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: BlueprintView.

PUT /api/blueprints/:fullname

Cria ou atualiza um blueprint.

Payload:

Campo	Obrigatório	Descrição
name	Sim	Blueprint name.
fullname	Sim	Blueprint fullname.
app	Sim	App fullname.
project	Sim	Project fullname.
workspace	Sim	Workspace fullname.
type	Sim	plain ou external.
data	Não	Object spec.
tags	Não	Tags.
labels	Não	Labels.
meta.title	Não	Título visível.
meta.description	Não	Descrição.

Resposta: BlueprintView.

DELETE /api/blueprints/:fullname

Elimina um blueprint.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: OperationResult.

Types

GET /api/types

Devolve shared types.

Argumentos:

Argumento	Localização	Descrição
project	Query	Filtro opcional por project.
workspace	Query	Filtro opcional por workspace.
status	Query	not_tested, ready ou broken.
pallet	Query	Filtro opcional por pallet.
kind	Query	event, call, transaction ou timer.
dataSource	Query	Filtro opcional por data source.

Payload: nenhum.

Resposta: SharedTypeView[].

GET /api/types/lookup

Resolve opções dinâmicas de tipos para o catálogo de um trigger.

Argumentos:

Argumento	Localização	Descrição
trigger	Query	Fullname do trigger.
ref	Query	Referência do type schema a resolver.
q	Query	Pesquisa de texto opcional.
value	Query	Valor exato opcional.
limit	Query	Limite de resultados opcional.
Campos adicionais	Query	Valores de dependências opcionais como series ou event.

Payload: nenhum.

A resposta contém ref, items normalizados com label, value e parents opcional, além de um nextCursor opcional.

GET /api/types/:fullname

Devolve um shared type.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: SharedTypeView.

PUT /api/types/:fullname

Cria ou atualiza um shared type.

Payload:

Campo	Obrigatório	Descrição
name	Sim	Shared type collection name.
fullname	Sim	Shared type fullname.
project	Sim	Project fullname.
workspace	Sim	Workspace fullname.
schemas	Sim	Objeto com named type schemas.
tags	Não	Tags.
labels	Não	Labels.
meta	Não	Metadata object.

Resposta: SharedTypeView.

DELETE /api/types/:fullname

Elimina um shared type.

Argumentos: fullname como path argument.

Payload: nenhum.

Resposta: OperationResult.