Mirrors/Part-DB-server
2
0
Fork 0
mirror of https://github.com/Part-DB/Part-DB-server.git synced 2026-02-20 00:33:45 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added possibility to add a change comment to changes via the API

Browse Source
This commit is contained in:
Jan Böhmer
2023-09-18 13:24:33 +02:00
parent 915444b5da
commit d2144a1fed
2 changed files with 70 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/api/intro.md
View File

@@ -88,4 +88,11 @@ You can achieve this using the `properties[]` query parameter with the name of t
For example if you only want to get the name and the description of a part, you can use `/api/parts/123?properties[]=name&properties[]=description`.
It is also possible to use this filters on list endpoints (get collection), to only get a subset of the properties of all entities in the collection.
See [API Platform docs](https://api-platform.com/docs/core/filters/#property-filter) for more infos.
See [API Platform docs](https://api-platform.com/docs/core/filters/#property-filter) for more infos.
## Change comment
Similar to the changes using Part-DB web interface, you can add a change comment to every change you make via the API, which will be
visible in the log of the entity.
You can pass the text for this via the `_comment` query parameter (beware the proper encoding). For example `/api/parts/123?_comment=This%20is%20a%20change%20comment`.