History:Server Release Notes/NGS Beta 1: Difference between revisions
Line 34: | Line 34: | ||
== Search changes == |
== Search changes == |
||
For information on our changes to the search support, see our [http://wiki.musicbrainz.org/Next_Generation_Schema/SearchServerXML search server NGS documentation]. |
|||
== Web service changes == |
== Web service changes == |
Revision as of 00:04, 19 January 2010
The MetaBrainz Foundation is proud to present the first beta of the long anticipated next generation schema (NGS). This beta release is the effort of numerous developers and years of planning, designing, and programming.
Nontheless, here we finally are!
How to Test
We'd really like you to just get stuck in and start using the site! The site is certainly rough around the edges, and we've started to capture a lot of known problems already (as you can see). However, if you don't manage to find an error in the server, please report it! We're using JIRA to do bug reporting now, but it's straight forward - just head to that site and click "Create Issue" in the top right. Briefly tell us what you were doing, and we'll do the rest of the sorting and try and get it fixed.
New features
Releases & Mediums
Releases in current MusicBrainz terminology represent a single disc, and there is no accurate way to group these entities together. NGS addresses this issue with another type of entity - the medium. A release now represents a final product that a customer would buy. Releases have 1 or more mediums, which could be a set of CDs, vinyl discs, or any combination of these. The easiest way to think about all of these is to remember the following:
- A release is the finished product that a consumer would purchase, which consists of many...
- Mediums which contain the actual audio content to listen to. Mediums have a specific type of format - CD, vinyl, digital media, etc
Tracklists & Recordings
With the introduction of mediums, we have also introduced a new concept - the tracklist. Sometimes exact same tracklist is featured on many different releases (for example, a CD single and a vinyl single, or boxset compilations). A tracklist is a bridge between a medium and the tracks it contains, which allows the same tracklist to appear on many different mediums.
Tracks are often released on multiple tracklists - for example, it is fairly common to have different tracklists depending on the region a release is released in. To group these different tracks together we now have recording entities. Recordings are not directly part of releases, every track on a mediums tracklist has a direct link to a recording - so multiple tracks can point to the same recording.
New website design
One of the major improvements this server release will have is a brand new website design and user interface. The amount of visual noise has been reduced and the overall experience had been streamlined, however, familiar key concepts (e.g. colored highlights on pending edits) have been kept.
Fixed bugs
Schema changes
The "next generation schema" is a broad term for the schema changes required to expand the depth of information MusicBrainz collects. The schema changes are vast, and at the moment we are focusing on realizing some of the most important of these changes.
Search changes
For information on our changes to the search support, see our search server NGS documentation.
Web service changes
In the Beta 1 version of the Web Service (the NGS web service), the following resources are available:
- artist
- release-group
- release
- recording
- label
- work
For each of these types, you can request data entities via MBID and collection searches using a search query. For instance, to request a release you can request:
http://test.musicbrainz.org/ws/2/release/cae2ac10-057f-3d29-9e9d-1ba58e67ab9f/?inc=artists+release-groups+recordings
Or to search the release collections, you can:
http://test.musicbrainz.org/ws/2/release/?query=<text search query>
The structure of the V2 web service is very similar to the V1 service. Please take a look at the complete documentation for the V1 service to give you more background for this service:
http://wiki.musicbrainz.org/XMLWebService
Inc options for available resources
The inc options for resources are as follows:
artist | aliases labels sa-album sa-single sa-ep sa-compilation sa-spokenword sa-interview sa-audiobook sa-live sa-remix sa-other sa-nat sa-official sa-promotion sa-bootleg sa-pseudo-release |
release-group | artists releases |
release | artists recordings releasegroups labels |
recording | artists releases |
label | aliases |
work | artists |
Various artist types/statuses are not supported yet.
Differences to the V1 Web Service
- Please note that the argument type=xml is no longer required. XML is now the default encoding.
- track(s) have been renamed to recording(s). Use recording wherever you would use track previously.
Not Supported
In beta 1 the following items are not supported yet:
- Any POST (write) operations
- ISRC lookup/submission
- PUID lookup/submission
- Discid lookup/submission
- Advanced relationships
- Collections
- Tags
- Ratings
Unfinished tasks
- The ability to add new releases (though we do have a release editor to edit existing releases)
- Relating to URLs
- CD Stubs (all functionality)
- Submitting CDs
- Timeline
- Dashboard
- Backward compatible v1 Web Service
- Full collection support