BradNut/graphbrainz
1
0
Fork 0
mirror of https://github.com/BradNut/graphbrainz synced 2025-09-08 17:40:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update docs & generated schema

Browse source
This commit is contained in:
Brian Beck 2016-12-02 00:49:39 -08:00
parent bb762f135f
commit 7832f608a0
3 changed files with 138 additions and 138 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
docs/schema.md
View file

@ -877,12 +877,6 @@ type PlaceEdge {
# The query root, from which multiple types of MusicBrainz
# requests can be made.
type Query {
# Fetches an object given its ID
node(
# The ID of an object
id: ID!
): Node
# Perform a lookup of a MusicBrainz entity by its MBID.
lookup: LookupQuery
@ -891,6 +885,12 @@ type Query {
# Search for MusicBrainz entities using Lucene query syntax.
search: SearchQuery
# Fetches an object given its ID
node(
# The ID of an object
id: ID!
): Node
}
# A [recording](https://musicbrainz.org/doc/Recording) is an

20
docs/types.md
View file

@ -89,16 +89,6 @@ requests can be made.
<th align="left">Type</th>
<th align="left">Description</th>
</thead><tbody>
<tr>
<td valign="top"><strong>node</strong></td>
<td valign="top"><a href="#node">Node</a></td>
<td>Fetches an object given its ID</td>
</tr>
<tr>
<td align="right" valign="top">id</td>
<td valign="top"><a href="#id">ID</a>!</td>
<td>The ID of an object</td>
</tr>
<tr>
<td valign="top"><strong>lookup</strong></td>
<td valign="top"><a href="#lookupquery">LookupQuery</a></td>
@ -114,6 +104,16 @@ requests can be made.
<td valign="top"><a href="#searchquery">SearchQuery</a></td>
<td>Search for MusicBrainz entities using Lucene query syntax.</td>
</tr>
<tr>
<td valign="top"><strong>node</strong></td>
<td valign="top"><a href="#node">Node</a></td>
<td>Fetches an object given its ID</td>
</tr>
<tr>
<td align="right" valign="top">id</td>
<td valign="top"><a href="#id">ID</a>!</td>
<td>The ID of an object</td>
</tr>
</tbody></table>
## Objects

244
schema.json
View file

@ -12,33 +12,6 @@
"name": "Query",
"description": "The query root, from which multiple types of MusicBrainz\nrequests can be made.",
"fields": [
{
"name": "node",
"description": "Fetches an object given its ID",
"args": [
{
"name": "id",
"description": "The ID of an object",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
},
{
"name": "lookup",
"description": "Perform a lookup of a MusicBrainz entity by its MBID.",
@ -74,110 +47,39 @@
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": null
},
{
"kind": "SCALAR",
"name": "ID",
"description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Node",
"description": "An object with an ID",
"fields": [
},
{
"name": "id",
"description": "The id of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
"name": "node",
"description": "Fetches an object given its ID",
"args": [
{
"name": "id",
"description": "The ID of an object",
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"defaultValue": null
}
],
"type": {
"kind": "INTERFACE",
"name": "Node",
"ofType": null
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"interfaces": [],
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Area",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Artist",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Recording",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Release",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Label",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ReleaseGroup",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Work",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Event",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Place",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Instrument",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Series",
"ofType": null
},
{
"kind": "OBJECT",
"name": "URL",
"ofType": null
}
]
"possibleTypes": null
},
{
"kind": "OBJECT",
@ -884,6 +786,104 @@
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Node",
"description": "An object with an ID",
"fields": [
{
"name": "id",
"description": "The id of the object.",
"args": [],
"type": {
"kind": "NON_NULL",
"name": null,
"ofType": {
"kind": "SCALAR",
"name": "ID",
"ofType": null
}
},
"isDeprecated": false,
"deprecationReason": null
}
],
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": [
{
"kind": "OBJECT",
"name": "Area",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Artist",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Recording",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Release",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Label",
"ofType": null
},
{
"kind": "OBJECT",
"name": "ReleaseGroup",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Work",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Event",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Place",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Instrument",
"ofType": null
},
{
"kind": "OBJECT",
"name": "Series",
"ofType": null
},
{
"kind": "OBJECT",
"name": "URL",
"ofType": null
}
]
},
{
"kind": "SCALAR",
"name": "ID",
"description": "The `ID` scalar type represents a unique identifier, often used to refetch an object or as key for a cache. The ID type appears in a JSON response as a String; however, it is not intended to be human-readable. When expected as an input type, any string (such as `\"4\"`) or integer (such as `4`) input value will be accepted as an ID.",
"fields": null,
"inputFields": null,
"interfaces": null,
"enumValues": null,
"possibleTypes": null
},
{
"kind": "INTERFACE",
"name": "Entity",