json/v1.0/estimate.json in sk_api_schema-0.3.4 vs json/v1.0/estimate.json in sk_api_schema-0.4.0

- old
+ new

@@ -1,18 +1,21 @@ { "type":"object", "title": "estimate", "description": "An estimate", "properties":{ "id":{ - "description": "UUID assigned by SK", + "description":"Unique identifier - UUID", "identity":true, "readonly":true, - "type":"string" + "type":"string", + "maxLength": 22, + "minLength":22 }, "number":{ "description": "Unique number assigned by SK estimate number schema. Auto-assigned when estimate is opened. Required unless doc status is draft.", - "type":"string" + "type":"string", + "maxLength": 50 }, "address_field":{ "description": "Receiver address, normally shown in envelope window. Defaults to client address_field if empty and client_id present.", "type":"string" }, @@ -36,26 +39,30 @@ "enum":["draft","open","closed","rejected","billed" ], "type":"string" }, "external_ref":{ "description": "Some external reference, whatever this may be.", - "type":"string" + "type":"string", + "maxLength": 255 }, "title":{ - "description": "The headline of a document. Use SK placeholders to prevent exessive typing e.g. 'Your estimate [number]'", - "type":"string" + "description": "The headline of a document. Use SK placeholders to prevent excessive typing e.g. 'Your estimate [number]'", + "type":"string", + "maxLength": 255 }, "notes_before":{ - "description": "Notes shown before the line items. Normaly contains salutation and other introductional information. SK placeholders can be used.", - "type":"string" + "description": "Notes shown before the line items. Normally contains salutation and other introductional information. SK placeholders can be used.", + "type":"string", + "format":"text" }, "notes_after":{ "description": "Notes shown after the line items. Can contain information about payments, bank account or a thank-you message. SK placeholders can be used.", - "type":"string" + "type":"string", + "format":"text" }, - "tag_list": { - "description": "Space separated list of tags.", + "tag_list":{ + "description": "Space separated list of tags. Are split and saved as Tag objects on create, update.", "type":"string" }, "language":{ "description": "Should be a valid language short-code: de-DE, fr, en-GB; like defined in your account language menu. When the document is emailed or printed, a localized version of a multi-language template(email, pdf) will be used if available. Defaults to the clients language, if empty and a client is assigned.", "type":"string", @@ -73,15 +80,19 @@ "type":"object", "properties":{"$ref":"./client.json#properties"} }, "client_id":{ "description": "The clients uuid. If a new client is assigned its language, address field are used if those fields are not set.", - "type":"string" + "type":"string", + "maxLength": 22, + "minLength":22 }, "team_id":{ "description": "A team uuid. If set only the team and its parent teams can see the record.", - "type":"string" + "type":"string", + "maxLength": 22, + "minLength":22 }, "line_items":{ "description": "Line items for the document", "type":"array", "properties":{"$ref":"./line_item.json#properties"} @@ -140,10 +151,10 @@ "description": "Results per page. Default is 10, max is 100", "type":"number" }, "filter[q]":{ "title" : "Search", - "description": "Search in title, number, addressfield", + "description": "Search in title, number, address field", "type":"string" }, "filter[number]":{ "title" : "Number", "description": "Find by exact number",