Development/Season of Docs/2019/MusicBrainz: Difference between revisions

Revision as of 18:27, 17 April 2019

Musicbrainz already has https://musicbrainz.org/doc/ as well as dev docs like https://musicbrainz.org/doc/Development and Guidelines https://musicbrainz.org/doc/Style and beginner-guides and how-to's; https://musicbrainz.org/doc/Beginners_Guide .
However much of things are outdated and will need updating and improving.
Documentation for our web service needs improvement:
- Development/XML_Web_Service/Version_2 is missing information about authenticating with OAuth.
- Development/JSON_Web_Service is incomplete, lacking a useful description of the data format, and any important differences with the XML web service.
We have no documentation about seeding entity forms. e.g. https://musicbrainz.org/artist/create?edit-artist.name=foo&rels.0.target=b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d

@@ Line 4: / Line 4: @@
 * Musicbrainz already has https://musicbrainz.org/doc/ as well as dev docs like https://musicbrainz.org/doc/Development and Guidelines https://musicbrainz.org/doc/Style and beginner-guides and how-to's; https://musicbrainz.org/doc/Beginners_Guide .
 * However much of things are outdated and will need updating and improving.
+* Documentation for our web service needs improvement:
+** [[Development/XML_Web_Service/Version_2]] is missing information about authenticating with OAuth.
+** [[Development/JSON_Web_Service]] is incomplete, lacking a useful description of the data format, and any important differences with the XML web service.
+* We have no documentation about seeding entity forms. e.g. https://musicbrainz.org/artist/create?edit-artist.name=foo&rels.0.target=b10bbbfc-cf9e-42e0-be17-e2c3e1d2600d