Song Collection

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "description": "A collection (or list) of resources.",
  "properties": {
    "items": {
      "description": "A collection of resources returned in the current result set.",
      "items": {
        "properties": {
          "artist": {
            "description": "Artist name.",
            "readOnly": true,
            "type": "string"
          },
          "duration": {
            "description": "Duration of the song, in seconds.",
            "readOnly": true,
            "type": "integer"
          },
          "id": {
            "$ref": "#/components/schemas/Id"
          },
          "instruments": {
            "description": "The instruments featured in the song.",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "type": "array"
          },
          "isInstrumental": {
            "description": "Whether the track is an instrumental or vocal track.",
            "readOnly": true,
            "type": "boolean"
          },
          "lyrics": {
            "description": "The lyrics for this song.",
            "readOnly": true,
            "type": "string"
          },
          "media": {
            "description": "The media URLs for the different streams and files.",
            "properties": {
              "artistThumbnailUrl": {
                "format": "uri",
                "readOnly": true,
                "type": "string"
              },
              "fullStreamUrl": {
                "format": "uri",
                "readOnly": true,
                "type": "string"
              },
              "sampleStreamUrl": {
                "format": "uri",
                "readOnly": true,
                "type": "string"
              }
            },
            "type": "object"
          },
          "moods": {
            "description": "The moods describing the song.",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "type": "array"
          },
          "styles": {
            "description": "The styles describing the song.",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "type": "array"
          },
          "tempo": {
            "description": "Tempo of the song.",
            "enum": [
              "fast",
              "medium",
              "slow"
            ],
            "readOnly": true,
            "type": "string"
          },
          "themes": {
            "description": "The themes describing the song.",
            "items": {
              "type": "string"
            },
            "readOnly": true,
            "type": "array"
          },
          "title": {
            "description": "Song title.",
            "readOnly": true,
            "type": "string"
          },
          "type": {
            "allOf": [
              {
                "$ref": "#/components/schemas/Type"
              },
              {
                "enum": [
                  "song"
                ]
              }
            ]
          }
        },
        "title": "Song",
        "type": "object"
      },
      "title": "Song",
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "meta": {
      "description": "Metadata describing the current result set.",
      "properties": {
        "currentPage": {
          "description": "The current page of results returned.",
          "type": "integer"
        },
        "rows": {
          "description": "The number of rows returned per page for the current result set.",
          "type": "integer"
        },
        "totalItems": {
          "description": "The total number of items in the result set. This may be\naffected by active search/filter parameters.",
          "type": "integer"
        },
        "totalPages": {
          "description": "The total number of pages in the result set. This is affected by\nthe `rows` parameter (`totalItems / rows == totalPages`).",
          "type": "integer"
        }
      },
      "readOnly": true,
      "type": "object"
    },
    "type": {
      "description": "The type of resource represented.",
      "enum": [
        "song-collection"
      ],
      "example": "resource-type",
      "title": "Resource Type",
      "type": "string"
    }
  },
  "required": [
    "type",
    "items"
  ],
  "title": "Collection of songs",
  "type": "object"
}