mirror of
https://github.com/KevinMidboe/linguist.git
synced 2025-10-29 17:50:22 +00:00
40 lines
1.0 KiB
Plaintext
40 lines
1.0 KiB
Plaintext
#%RAML 0.8
|
|
|
|
title: World Music API
|
|
baseUri: http://example.api.com/{version}
|
|
version: v1
|
|
traits:
|
|
- paged:
|
|
queryParameters:
|
|
pages:
|
|
description: The number of pages to return
|
|
type: number
|
|
- secured: !include http://raml-example.com/secured.yml
|
|
/songs:
|
|
is: [ paged, secured ]
|
|
get:
|
|
queryParameters:
|
|
genre:
|
|
description: filter the songs by genre
|
|
post:
|
|
/{songId}:
|
|
get:
|
|
responses:
|
|
200:
|
|
body:
|
|
application/json:
|
|
schema: |
|
|
{ "$schema": "http://json-schema.org/schema",
|
|
"type": "object",
|
|
"description": "A canonical song",
|
|
"properties": {
|
|
"title": { "type": "string" },
|
|
"artist": { "type": "string" }
|
|
},
|
|
"required": [ "title", "artist" ]
|
|
}
|
|
application/xml:
|
|
delete:
|
|
description: |
|
|
This method will *delete* an **individual song**
|