✨ feat(actions): meta.openapi für Aktionen typisieren und validieren (#40)
continuous-integration/drone/push Build is passing
continuous-integration/drone/push Build is passing
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.
This commit is contained in:
1 parent
4e13d4ab9a
commit
11069d83d4
5 files changed
+110
-8
No files matched your search
@@ -3,6 +3,19 @@ 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:
|
||||
|
||||
Reference in new issue
Block a user