Skip to content

docs: expand RIDL example with annotations and REST routes - #24

Merged
david-littlefarmer merged 2 commits into
masterfrom
docs/expand-ridl-examples
Oct 21, 2026
Merged

david-littlefarmer merged 2 commits into
masterfrom
docs/expand-ridl-examples

Conversation

@david-littlefarmer

Copy link
Copy Markdown
Member

Expand _examples/e1.ridl to demonstrate the annotation and REST syntax added in recent releases: basepath, GET/POST/PUT/PATCH/DELETE/QUERY routes, compatibility routes, method annotations with flag and quoted values, success-code sets, and errors without an explicit HTTP status.

Keep all examples in e1.ridl, including the existing deprecated annotations that demonstrate migration. Use + @success 200|201 without =, with one declaration shared by all routes of a method. Add make format-all to exercise recursive formatting.

Validation: go test ./... and git diff --check pass. The expanded example formats successfully and remains unchanged on a second formatting pass.

@david-littlefarmer
david-littlefarmer merged commit 6d521c1 into master Oct 21, 2026
1 check passed
@david-littlefarmer
david-littlefarmer deleted the docs/expand-ridl-examples branch October 21, 2026 07:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant