Files
tibi-types/demo-api/actions/demo-action.yml
T
apairon 11069d83d4
continuous-integration/drone/push Build is passing
✨ feat(actions): meta.openapi für Aktionen typisieren und validieren (#40)
Aktionen erscheinen in der generierten OpenAPI-Spec als /_actions/<name>.
Dafür trägt die Action-Meta jetzt denselben openapi-Block wie eine Sammlung:

- action.schema.json: meta.openapi referenziert openapi.schema.json
  (bisher lehnte additionalProperties: false den Block ab).
- openapi.schema.json: Beschreibung deckt Sammlung und Aktion ab, get/getOne/
  post/put/delete sind entsprechend erläutert.
- index.d.ts: ActionMeta.openapi plus OpenapiMeta/OpenapiOperationMeta/
  OpenapiParameter.
- demo-api/actions/demo-action.yml und types-test/action-openapi.ts zeigen
  und prüfen die Form.
2026-11-11 08:50:17 +00:00

70 lines
1.5 KiB
YAML

# yaml-language-server: $schema=../../schemas/config/action.schema.json
name: demo-action
meta:
label: { de: Demo Aktion, en: Demo Action }
# The action shows up in GET /_openapi/:project as /_actions/demo-action,
# with the same override block a collection uses.
openapi:
get:
summary: { de: Demo-Aktion lesen, en: Read the demo action }
parameters:
- name: verbose
in: query
required: false
schema:
type: boolean
post:
summary: { de: Demo-Aktion ausführen, en: Run the demo action }
methods:
get:
query:
title: { de: Demo Query, en: Demo Query }
fields:
- name: verbose
type: boolean
execution:
kind: sync
post:
data:
title: { de: Demo Input, en: Demo Input }
fields:
- name: dryRun
type: boolean
execution:
kind: sse
cancellable: true
output:
title: { de: Demo Ergebnis, en: Demo Result }
mapping:
summary:
fields:
- source: result.status
type: string
meta:
label: { de: Status, en: Status }
permissions:
public:
methods:
get: true
post: false
user:
methods:
get: true
post: false
admin:
methods:
get: true
post: true
hooks:
get:
handle:
type: javascript
file: hooks/demo-action/get_handle.js
post:
handle:
type: javascript
file: hooks/demo-action/post_handle.js