Details
-
New Feature
-
Status: Closed
-
TBD
-
Resolution: Won't Fix
-
None
-
None
-
None
-
Low
Description
From my IRCs with people trying to use RESTWS, I find there is a need to document the required fields of a resource so users know the minimum they have to send to create a new resource.
In connection with the upcoming subclass solution, I find there is a need to document the subclass variables of a subclass, since the full rep will surely include a full rep of the parent class variables.
I think the best way to keep the documentation current will be to do it as representations. Therefore, I propose the following new standard representations:
- min or req – the required variables of a resource
- subclass – the subclass variables of a subclass resource