| 1 |
{ |
| 2 |
"metadata":{ |
| 3 |
"apiVersion":"2015-04-01", |
| 4 |
"endpointPrefix":"todo", |
| 5 |
"jsonVersion":"1.1", |
| 6 |
"serviceFullName":"AWS ToDo Sample API for Tasks", |
| 7 |
"serviceAbbreviation":"AWS ToDo Tasks", |
| 8 |
"signatureVersion":"v4", |
| 9 |
"protocol":"json" |
| 10 |
}, |
| 11 |
"documentation":"<p>AWS sample API that tracks to-do items.</p><ul></ul>", |
| 12 |
"operations":{ |
| 13 |
"CreateToDo":{ |
| 14 |
"name":"CreateToDo", |
| 15 |
"http":{ |
| 16 |
"method":"POST", |
| 17 |
"requestUri":"/todos" |
| 18 |
}, |
| 19 |
"input":{ |
| 20 |
"shape":"CreateToDoInput", |
| 21 |
"documentation":"<p>Container of the newly created to-do's values.</p>" |
| 22 |
}, |
| 23 |
"output":{ |
| 24 |
"shape":"ToDoItem", |
| 25 |
"documentation":"<p>A single ToDo item.</p>" |
| 26 |
}, |
| 27 |
"errors":[ |
| 28 |
{ |
| 29 |
"shape":"ToDoServerException", |
| 30 |
"exception":true, |
| 31 |
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>" |
| 32 |
}, |
| 33 |
{ |
| 34 |
"shape":"ToDoClientException", |
| 35 |
"exception":true, |
| 36 |
"documentation":"<p>The API was called with invalid parameters. The error message will contain additional details about the cause.</p>" |
| 37 |
} |
| 38 |
], |
| 39 |
"documentation":"<p>Create a new to-do item.</p>" |
| 40 |
}, |
| 41 |
"DescribeToDos": { |
| 42 |
"name":"DescribeToDos", |
| 43 |
"http":{ |
| 44 |
"method":"GET", |
| 45 |
"requestUri":"/todos" |
| 46 |
}, |
| 47 |
"output":{ |
| 48 |
"shape":"ToDoList", |
| 49 |
"documentation":"<p>List of to-do items.</p>" |
| 50 |
}, |
| 51 |
"errors":[ |
| 52 |
{ |
| 53 |
"shape":"ToDoServerException", |
| 54 |
"exception":true, |
| 55 |
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>" |
| 56 |
} |
| 57 |
], |
| 58 |
"documentation":"<p>Create a new to-do item.</p>" |
| 59 |
}, |
| 60 |
"GetToDo":{ |
| 61 |
"name":"GetToDo", |
| 62 |
"http":{ |
| 63 |
"method":"GET", |
| 64 |
"requestUri":"/todos/{Id+}" |
| 65 |
}, |
| 66 |
"input":{ |
| 67 |
"shape":"ToDoInput" |
| 68 |
}, |
| 69 |
"output":{ |
| 70 |
"shape":"ToDoItem" |
| 71 |
}, |
| 72 |
"errors":[ |
| 73 |
{ |
| 74 |
"shape":"ToDoServerException", |
| 75 |
"exception":true, |
| 76 |
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>" |
| 77 |
}, |
| 78 |
{ |
| 79 |
"shape":"ToDoClientException", |
| 80 |
"exception":true, |
| 81 |
"documentation":"<p>The API was called with invalid parameters. The error message will contain additional details about the cause.</p>" |
| 82 |
} |
| 83 |
], |
| 84 |
"documentation":"<p>Get an existing to-do item.</p>" |
| 85 |
}, |
| 86 |
"DeleteToDo":{ |
| 87 |
"name":"DeleteToDo", |
| 88 |
"http":{ |
| 89 |
"method":"DELETE", |
| 90 |
"requestUri":"/todos/{Id+}" |
| 91 |
}, |
| 92 |
"input":{ |
| 93 |
"shape":"ToDoInput" |
| 94 |
}, |
| 95 |
"errors":[ |
| 96 |
{ |
| 97 |
"shape":"ToDoServerException", |
| 98 |
"exception":true, |
| 99 |
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>" |
| 100 |
}, |
| 101 |
{ |
| 102 |
"shape":"ToDoClientException", |
| 103 |
"exception":true, |
| 104 |
"documentation":"<p>The API was called with invalid parameters. The error message will contain additional details about the cause.</p>" |
| 105 |
} |
| 106 |
], |
| 107 |
"documentation":"<p>Delete an existing to-do item.</p>" |
| 108 |
} |
| 109 |
}, |
| 110 |
"shapes":{ |
| 111 |
"CreateToDoInput":{ |
| 112 |
"type":"structure", |
| 113 |
"required":[ |
| 114 |
"Title" |
| 115 |
], |
| 116 |
"members":{ |
| 117 |
"Title":{ |
| 118 |
"shape":"String", |
| 119 |
"documentation":"The title of the to-do item." |
| 120 |
} |
| 121 |
}, |
| 122 |
"documentation":"<p>Container for to-do values.</p>" |
| 123 |
}, |
| 124 |
"String":{ |
| 125 |
"type":"string" |
| 126 |
}, |
| 127 |
"ToDoClientException":{ |
| 128 |
"type":"structure", |
| 129 |
"members":{ |
| 130 |
"message":{"shape":"ErrorMessage"} |
| 131 |
}, |
| 132 |
"exception":true, |
| 133 |
"documentation":"<p>The API was called with invalid parameters. The error message will contain additional details about the cause.</p>" |
| 134 |
}, |
| 135 |
"ToDoInput":{ |
| 136 |
"type":"structure", |
| 137 |
"required":[ |
| 138 |
"Id" |
| 139 |
], |
| 140 |
"members":{ |
| 141 |
"Id":{ |
| 142 |
"shape":"String", |
| 143 |
"location":"uri", |
| 144 |
"locationName":"Id" |
| 145 |
} |
| 146 |
} |
| 147 |
}, |
| 148 |
"ToDoItem":{ |
| 149 |
"type":"structure", |
| 150 |
"members":{ |
| 151 |
"Id":{ |
| 152 |
"shape":"String", |
| 153 |
"documentation":"Unique identifier" |
| 154 |
}, |
| 155 |
"Title":{ |
| 156 |
"shape":"String", |
| 157 |
"documentation":"The title of the to-do item." |
| 158 |
}, |
| 159 |
"Status":{ |
| 160 |
"shape":"String", |
| 161 |
"documentation":"The status of the to-do item. Either <i>CREATING</i>, <i>READY</i>, or <i>DONE</i>." |
| 162 |
} |
| 163 |
}, |
| 164 |
"documentation":"A single to-do item." |
| 165 |
}, |
| 166 |
"ToDoList":{ |
| 167 |
"type":"list", |
| 168 |
"member":{ |
| 169 |
"shape":"ToDoItem", |
| 170 |
"documentation":"List of to-do items." |
| 171 |
} |
| 172 |
}, |
| 173 |
"ToDoServerException":{ |
| 174 |
"type":"structure", |
| 175 |
"members":{ |
| 176 |
"message":{"shape":"ErrorMessage"} |
| 177 |
}, |
| 178 |
"exception":true, |
| 179 |
"documentation":"<p>A server-side error occurred during the API call. The error message will contain additional details about the cause.</p>" |
| 180 |
}, |
| 181 |
"ErrorMessage":{ |
| 182 |
"type":"string" |
| 183 |
} |
| 184 |
} |
| 185 |
} |