Document PATCH method - Githubissues

gbv / jskos-server

Web service to access JSKOS data

https://coli-conc.gbv.de/api/

MIT License

6 stars 4 forks source link

Document PATCH method #213

Closed nichtich closed 10 months ago

nichtich commented 10 months ago

The PATCH methods should be documented in README. I think it is this:

request body is expected to be a JSON object (are arrays possible too?)
fields of the request object get added to the object to be patched or replace existing fields of same name
if field value of request object is null, the field of the object to be patched is removed.

stefandesu commented 10 months ago

These things are documented under the general "API" heading in README: https://github.com/gbv/jskos-server#api

I guess your first two points were kind of implicit because that's how PATCH works in general, but we can be more explicit in the README. The last point is already documented explicitly.