API endpoint to search songs from the database given a query

v1.0.0

Endpoint for an end-user client to search songs from the database given a String query.

If you want to run the /song/search operation, you can do so via an HTTP GET command to the following URL:

Input

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    }
  },
  "required": [
    "query"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "properties": {
    "error": {
      "type": "boolean",
      "description": "Whether or not the request was successfully processed or not."
    },
    "message": {
      "type": "string",
      "description": "Error message if the request was unsuccessful."
    },
    "response": {
      "type": "object",
      "description": "Contains the response data if the request was successful.",
      "properties": {
        "results": {
          "type": "array",
          "description": "Contains all the songs.",
          "items": {
            "type": "object",
            "description": "Song item.",
            "properties": {
              "id": {
                "type": "integer",
                "description": "Song internal identifier."
              },
              "name": {
                "type": "string",
                "description": "Song and Artist name."
              }
            }
          }
        }
      }
    }
  }
}