UNPKG

@ianwalter/peregrin

Version:

Toolkit for converting API Blueprint files to JSON and consuming that JSON

123 lines 3.97 kB
[ { "name": "User", "description": "API resources used by individual users.", "resources": [ { "element": "resource", "name": "Account", "description": "Resource for working with user account information.", "uriTemplate": "/account", "model": {}, "parameters": [], "actions": [ { "name": "Get Account Information", "description": "Action for retrieving a user's account information.", "method": "GET", "parameters": [], "attributes": { "relation": "", "uriTemplate": "" }, "content": [], "examples": [ { "name": "", "description": "", "requests": [], "responses": [ { "name": "200", "description": "", "headers": [ { "name": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"email\": \"user@test.io\"\n}\n", "schema": "", "content": [ { "element": "asset", "attributes": { "role": "bodyExample" }, "content": "{\n \"id\": 1,\n \"email\": \"user@test.io\"\n}\n" } ] } ] } ] }, { "name": "Update Account Information", "description": "Action for updating a user's account information.", "method": "PUT", "parameters": [], "attributes": { "relation": "", "uriTemplate": "" }, "content": [], "examples": [ { "name": "", "description": "", "requests": [ { "name": "", "description": "", "headers": [ { "name": "Content-Type", "value": "application/json" } ], "body": "{\n \"id\": 1,\n \"email\": \"user@example.com\"\n}\n", "schema": "", "content": [ { "element": "asset", "attributes": { "role": "bodyExample" }, "content": "{\n \"id\": 1,\n \"email\": \"user@example.com\"\n}\n" } ] } ], "responses": [ { "name": "200", "description": "", "headers": [ { "name": "Content-Type", "value": "application/json" } ], "body": " {\n \"id\": 1,\n \"email\": \"user@example.com\"\n }\n", "schema": "", "content": [ { "element": "asset", "attributes": { "role": "bodyExample" }, "content": " {\n \"id\": 1,\n \"email\": \"user@example.com\"\n }\n" } ] } ] } ] } ], "content": [] } ] } ]