diff --git a/Lambdas/Lists/List/README.md b/Lambdas/Lists/List/README.md new file mode 100644 index 0000000..6eaf910 --- /dev/null +++ b/Lambdas/Lists/List/README.md @@ -0,0 +1,85 @@ +# List Module +Deals with managing the user-facing list creation, deletion, retrieval, and renaming. The supporting classes here also serve as resources for other modules. + +### Notable +[ListPermission.java](https://github.com/ClaytonWWilson/Listify/blob/master/Lambdas/Lists/List/src/ListPermissions.java) contains the lambda-side translation from permissionLevel to actual permissions. Keys updated on the client side must also be updated here. + +### ListGET +Retrieves details for an existing list +#### Expected request body: +N/A + +#### Expected query parameters: + - id + - Used for specifying which list to retrieve + - Valid values: -1,1