Details
-
Task
-
Status: Open (View Workflow)
-
P3
-
Resolution: Unresolved
-
None
-
None
-
-
Vega
Description
High priority APIs
- mod-circulation-storage: /loan-storage/loans
Acceptance criteria:
- Documentation for each attribute should include:
- A description of what the attribute means
- The precise domain of the attribute (range of values, controlled vocabulary, etc.)
- Whether the attribute is required or optional
- Where to find referenced data, if the attribute is a foreign key
- Any other constraints on the data, e.g. whether an attribute allows only unique values
Two examples of attribute documentation:
I.
Attribute name: username
Description: The user's login name. This also serves as an unique,
human-readable identifier for the user.
Domain: String of alphanumeric Unicode characters, beginning with
an alphabetic character. Maximum of 16 characters.
Required: Yes
References: N/A
Other constraints: Unique, but may be reused after the user is deleted.
II.
Attribute name: patronGroup
Description: The patron group that the user belongs to.
Domain: UUID
Required: Yes
References: "User Groups" /groups/{groupId} (e.g. mod-users)
Other constraints: None
These examples are intended not to prescribe a documentation format or style but to illustrate further the basic documentation content being requested.
TestRail: Results
Attachments
Issue Links
- defines
-
UXPROD-1414 Complete the documentation of data attributes in module APIs
-
- Closed
-
- relates to
-
FOLIO-1551 Missing or incomplete documentation of data attributes in many module APIs
-
- Closed
-