Loans
(UXPROD-788)
|
|
| 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: |
|
||||||||||||||||
| Sprint: | |||||||||||||||||
| Development Team: | Vega | ||||||||||||||||
| Epic Link: | Loans | ||||||||||||||||
| Description |
|
High priority APIs
Acceptance criteria:
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 |