Merge pull request #273 from radiantearth/pv/allow-subset-of-cat-or-c…

…oll-for-children explicitly state /children may return fewer fields for its entities
radiantearth · Mar 4, 2022 · ad2c2a0 · ad2c2a0
2 parents 722e3ba + 2ee0f63
commit ad2c2a0
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -105,6 +105,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - The required Link Relations and endpoints for each conformance class now use the wording of 'shall'
   instead of 'should'. While this technically changes the semantics, it was generally understood
   previously the semantics were those of 'shall' (must).
+- Explicitly state that the `/children` endpoint can return Catalog and Collection objects that have fewer
+  fields than are available through other endpoints.
 
 ### Deprecated
 

diff --git a/children/README.md b/children/README.md
@@ -22,7 +22,8 @@ the immediate children of a Catalog, which may be Catalog or Collection objects.
 While the `child` link relations in a Catalog already allow for describing these
 relationships, this scheme requires a client to retrieve each resource URL to find any information about
 the children (e.g., title, description), which can cause significant performance issues in user-facing
-applications.
+applications. Implementers may choose to to return only a subset of fields for each Catalog or Collection,
+but the objects must still be valid Catalogs and Collections.
 
 ## Link Relations