Uploaded image for project: 'MusicBrainz Server'
  1. MusicBrainz Server
  2. MBS-5307

ws/2 documentation is incomplete and confusing

    XMLWordPrintable

    Details

    • Type: Improvement
    • Status: Open
    • Priority: Normal
    • Resolution: Unresolved
    • Affects Version/s: None
    • Fix Version/s: None
    • Component/s: Documentation, Web service
    • Labels:
      None

      Description

      I think the documentation at http://wiki.musicbrainz.org/XML_Webservice could be improved. Currently it groups together the options provided for different entities so:

      It is very difficult to work out exactly what inc combinations are allowed for any top level entity,
      It is not clear what the effect of and inc is (i.e inc=aliases, means aliases should be shown for what)
      There is no example output either
      This lack of clarity has contributed to some of the bugs introduced into the webservice since its launch

      Would be clearer if we have a separate section for each toplevel entity as follows:

      entityname (i.e release)

      Explanation
      inc values supported
      Some example output

      Also needs updating for Json output.

        Attachments

          Issue Links

            Activity

              People

              • Assignee:
                Unassigned
                Reporter:
                ijabz Paul Taylor
              • Votes:
                3 Vote for this issue
                Watchers:
                4 Start watching this issue

                Dates

                • Created:
                  Updated:

                  Packages

                  Version Package