json/v1.0/client.json in sk_api_schema-0.0.18 vs json/v1.0/client.json in sk_api_schema-0.1.0
- old
+ new
@@ -155,28 +155,40 @@
"page":{
"title" : "Page",
"description": "In paginated results set the page to look for",
"type":"number"
},
+ "per_page":{
+ "title" : "Per page",
+ "description": "Results per page. Default is 10, max is 100",
+ "type":"number"
+ },
"filter[q]":{
"title" : "Search",
- "description": "Search in first, last_name, organisation, email, number",
+ "description": "Wildcard search in first, last_name, organisation, email, number",
"type":"string"
},
"filter[tags]":{
"title" : "Tags",
"description": "Filter by a space delimited list of tags",
"type":"string"
},
- "filter[from]":{
+ "filter[created_at_from]":{
"title" : "From date",
- "description": "All objects with a date after the date"
+ "description": "All objects with a creation date after the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+ "type" : "date-time"
},
- "filter[to]":{
+ "filter[created_at_to]":{
"title" : "To date",
- "description": "All objects with date before the date"
+ "description": "All objects with a creation date before the date, including given datetime. ISO 8601 format YYY-MM-DDThh:mm:ss+z",
+ "type" : "date-time"
},
+ "filter[number]":{
+ "title" : "By number",
+ "description": "Search by number where the number is matched from the start: %number",
+ "type" : "date"
+ },
"sort_by":{
"title" : "Sort by",
"description": "Sort the results by the given field => number",
"enum":["organisation", "number","email","first_name","last_name", "created_at", "updated_at"],
"type": "string"
@@ -197,9 +209,12 @@
"method": "PUT"
},
{ "rel": "create",
"href": "clients",
"method": "POST"
+ },
+ { "rel": "documents",
+ "href": "clients/{id}/documents"
},
{ "rel": "attachments",
"href": "clients/{id}/attachments"
},
{ "rel": "invoices",
\ No newline at end of file