Skip to content

HTTP-Endpunkte

Alle Endpunkte der NENE2-Beispielanwendung. Alle JSON-Antworten folgen den Schemas in docs/openapi/openapi.yaml.

Gesundheit und Diagnose

MethodePfadAuthAntwort
GET/healthKeine200 { service, status[, checks] } oder 503 bei Degradierung
GET/examples/pingKeine200 { message }
GET/Keine200 { name, description, status } JSON-Antwort

Notes (Notizen)

MethodePfadAuthErfolgFehler
GET/examples/notesKeine200 Liste422
POST/examples/notesKeine201 Notiz400, 413, 422
GET/examples/notes/{id}Keine200 Notiz404, 413
PUT/examples/notes/{id}Keine200 Notiz400, 404, 413, 422
DELETE/examples/notes/{id}Keine204404

Tags (Schlagwörter)

MethodePfadAuthErfolgFehler
GET/examples/tagsKeine200 Liste422
POST/examples/tagsKeine201 Tag400, 413, 422
GET/examples/tags/{id}Keine200 Tag404
PUT/examples/tags/{id}Keine200 Tag400, 404, 422
DELETE/examples/tags/{id}Keine204404

Geschützt (Machine-Client)

MethodePfadAuthErfolgFehler
GET/examples/protectedX-NENE2-API-Key oder Bearer200 JSON401

Fehlerantworten folgen RFC 9457 Problem Details.

Veröffentlicht unter der MIT-Lizenz.