HTTP Endpoints

All endpoints exposed by the NENE2 example application. Every JSON response follows the schemas in docs/openapi/openapi.yaml.

Health and diagnostics

Method	Path	Auth	Response
GET	/health	None	200 { service, status[, checks] } · 503 when any check fails
GET	/examples/ping	None	200 { message }
GET	/	None	200 { name, description, status } JSON smoke response

Notes

Method	Path	Auth	Success	Errors
GET	/examples/notes	None	200	422
POST	/examples/notes	None	201	400, 413, 422
GET	/examples/notes/{id}	None	200	404, 413
PUT	/examples/notes/{id}	None	200	400, 404, 413, 422
DELETE	/examples/notes/{id}	None	204	404

Tags

Method	Path	Auth	Success	Errors
GET	/examples/tags	None	200	422
POST	/examples/tags	None	201	400, 413, 422
GET	/examples/tags/{id}	None	200	404
PUT	/examples/tags/{id}	None	200	400, 404, 422
DELETE	/examples/tags/{id}	None	204	404

Protected (machine client)

Method	Path	Auth	Success	Errors
GET	/examples/protected	Bearer token	200	401

Requests to the protected endpoint must include a valid Authorization: Bearer <token> header with a JWT signed with NENE2_LOCAL_JWT_SECRET.

Response shapes

Collection envelope (shared by Notes and Tags):

{ "items": [...], "limit": 20, "offset": 0 }

Note object:

{ "id": 1, "title": "My note", "body": "Content here" }

Tag object:

{ "id": 1, "name": "backend" }

Error responses follow RFC 9457 Problem Details.