Loans (UXPROD-788)

[CIRCSTORE-144] Missing or incomplete documentation of data attributes in mod-circulation-storage Created: 10/Oct/18  Updated: 24/Mar/22

Status: Open
Project: mod-circulation-storage
Components: None
Affects versions: None
Fix versions: None
Parent: Loans

Type: Task Priority: P3
Reporter: Nassib Nassar Assignee: Unassigned
Resolution: Unresolved Votes: 0
Labels: back-end, documentation
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original estimate: Not Specified

Issue links:
Defines
defines UXPROD-1414 Complete the documentation of data at... Closed
Relates
relates to FOLIO-1551 Missing or incomplete documentation o... Closed
Sprint:
Development Team: Vega
Epic Link: Loans

 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.



 Comments   
Comment by Nassib Nassar [ 06/Nov/18 ]

For an initial round, the following interface would be most useful:

mod-circulation-storage: /loan-storage/loans

Generated at Thu Feb 08 23:14:18 UTC 2024 using Jira 1001.0.0-SNAPSHOT#100246-sha1:7a5c50119eb0633d306e14180817ddef5e80c75d.