g4borg/miniweb
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: a bit better

Browse Source
This commit is contained in:
Gabor Körber 2024-06-01 21:07:08 +02:00
parent 6e845238bb
commit 1799cadcbd
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/readme.md
View File

@ -27,12 +27,12 @@ To implement an Admin Repository, you can look at the empty_repository example.
the AdminRepository trait requires you to implement: the AdminRepository trait requires you to implement:
- an associated type Key, that implements PrimaryKeyType - an associated type Key, that implements PrimaryKeyType
- key_from_string, which transforms a String into your Key - *key_from_string*, which transforms a String into your Key
- info, which produces an instance of RepositoryInformation for the Registry - *info* for the Registry (producing an instance of RepositoryInformation)
- list, listing entries of your repository, with optional pagination - *list* your repository items, with optional pagination
- create, creating a new entry into your repository (data is json serialized) - *create* a new entry into your repository (data is json serialized)
- get, getting a single entry of your repository - *get* a single entry of your repository
- update, updating an entry in your repository partially (patch) - *update* an entry in your repository partially (patch)
- replace, updating an entry in your repository (put) - *replace* an entry in your repository (put)
- delete, deleting a single entry in your repository - *delete* a single entry in your repository