Skip to content

Commit

Permalink
Update collection name example (#206)
Browse files Browse the repository at this point in the history
Replace 'people' which isn't recommended term
  • Loading branch information
pvdbosch authored Nov 27, 2024
1 parent e4d1382 commit b05e931
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions guide/src/main/asciidoc/resources-collection.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,14 @@ A collection resource is a server-managed list of document resources.
[rule, col-name]
.Collection name
====
A plural noun SHOULD be used for collection names, for example 'employers' or 'people'.
A plural noun SHOULD be used for collection names, for example 'employers' or 'children'.
====

.Collection of employers
.Collection name
====
{API}/employers[^]
{API}/employers[^] - a collection of employers
{API}/persons/{ssin}/children[^] - a collection of children as a child resource of a person
====

[[collections-consult, Consulting a collection]]
Expand Down

0 comments on commit b05e931

Please sign in to comment.