{"note":"OpenAPI conversion -- returning structured metadata","name":"freesound-org","description":"Freesound","version":"2.0.0","base_url":"http://www.freesound.org/apiv2","endpoints":2,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Freesound\n@base http://www.freesound.org/apiv2\n@version 2.0.0\n@endpoints 2\n@toc search(1), sounds(1)\n\n@group search\n@endpoint GET /search/text\n@desc Search sounds\n@optional {query: any # The query! The query is the main parameter used to define a query. You can type several terms separated by spaces or phrases wrapped inside quote ‘”’ characters. For every term, you can also use ‘+’ and ‘-‘ modifier characters to indicate that a term is “mandatory” or “prohibited” (by default, terms are considered to be “mandatory”). For example, in a query such as query=term_a -term_b, sounds including term_b will not match the search criteria. The query does a weighted search over some sound properties including sound tags, the sound name, its description, pack name and the sound id. Therefore, searching for query=123 will find you sounds with id 1234, sounds that have 1234 in the description, in the tags, etc. You’ll find some examples below. Using an empty query (query= or query=\"\") will return all Freeosund sounds., filter: any # Allows filtering query results. See below for more information., sort: any # Indicates how query results should be sorted. See below for a list of the sorting options. By default `sort=score`.          Option     Explanation           score     Sort by a relevance score returned by our search engine (default).           duration_desc     Sort by the duration of the sounds, longest sounds first.           duration_asc     Same as above, but shortest sounds first.           created_desc     Sort by the date of when the sound was added. newest sounds first.           created_asc     Same as above, but oldest sounds first.           downloads_desc     Sort by the number of downloads, most downloaded sounds first.           downloads_asc     Same as above, but least downloaded sounds first.           rating_desc     Sort by the average rating given to the sounds, highest rated first.           rating_asc     Same as above, but lowest rated sounds first., group_by_pack: any # This parameter represents a boolean option to indicate whether to collapse results belonging to sounds of the same pack into single entries in the results list. If `group_by_pack=1` and search results contain more than one sound that belongs to the same pack, only one sound for each distinct pack is returned (sounds with no packs are returned as well). However, the returned sound will feature two extra properties to access these other sounds omitted from the results list: `n_from_same_pack`: indicates how many other results belong to the same pack (and have not been returned) `more_from_same_pack`: uri pointing to the list of omitted sound results of the same pack (also including the result which has already been returned). See examples below. By default `group_by_pack=0`., page: any # Query results are paginated, this parameter indicates what page should be returned. By default `page=1`., page_size: any # Indicates the number of sounds per page to include in the result. By default `page_size=15`, and the maximum is `page_size=150`. Not that with bigger `page_size`, more data will need to be transferred.}\n@returns(200) successful operation\n@errors {400: Invalid status value}\n\n@endgroup\n\n@group sounds\n@endpoint GET /sounds/{soundId}\n@desc Details of a sound\n@required {soundId: any # ID of the sound that needs to be fetched}\n@returns(200) successful operation\n@errors {400: Invalid ID supplied, 404: Order not found}\n\n@endgroup\n\n@end\n"}