api_format.md: missing or incorrect documentation #443
Description
Hi,
scanning the January snapshot, I noticed the following documentation issues in rest-api-doc/api_format.md:
- contributor.name, contributor.sequence, contributor.suffix are not documented
- update.updated is documented as a partial date, but is (or can be) a full date
- assertion.explanation is documented as a string, but is a structured object with an embedded URL
- license.start is documented as a partial date, but is (or can be) a full date
- alternative-id is documented as a string, but is an array of strings
It would be great if these could be added or corrected.
It would also be good if the relation labels could be documented. So far I've seen
- cites (haven't seen "is-cited-by")
- references, is-referenced-by
- has-preprint, is-preprint-of
- has-part, is-part-of
- is-supplement-to, is-supplemented-by
- has-review, is-review-of
- is-identical-to
- has-version, is-version-of
- is-variant-form-of
- is-basis-for, is-based-on
- has-comment, is-comment-on
- continues, is-continued-by
- replaces, is-replaced-by
- documents, is-documented-by
- has-related-material, is-related-material
- based-on-data, is-data-basis-for
- has-derivation, is-derived-from
- is-reply-to (haven't seen the inverse, "has-reply")
- has-translation, is-translation-of
- has-manifestation, is-manifestation-of
Thanks!
Cheers, Oli