fidor_schema 0.1.18 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d20bce8312da6521a63aa2702dbe8422a20d2ce1
-  data.tar.gz: 3b140e2370a078335051e76edf9bdd947d96df4b
+  metadata.gz: 24d900fc95b176724776d4c8b8506ffd05790c43
+  data.tar.gz: 9c1f602c2f2aeb071f1d38b4fa597756bf1dcfb0
 SHA512:
-  metadata.gz: 34011c7dc15704691350254dcff74eb7a9f9d15ad2a26c15b86aceba812a4f28468116d093aefa1ddd3eaad5907f5fc262526fb4b3ca33bed283c37cedcea662
-  data.tar.gz: c66566de7bd062112314300b4b4c51ddbbea51cacd95797523bd02543fb8f5873bcfb0bb4a71662660c51c31c53243b059225bd0ded7846f53c90c283154231b
+  metadata.gz: 227dd314a9485593c3ed03d2283bd6f54728af9f8053e52cf5a444b39cd3d55c642613c9226903434f7000ca24fbdd09763ca33b7dc4d8a4a8590b138189080d
+  data.tar.gz: be6b447b8639d0ff9f0115b5bbdcda5affa57585ca433cf04b4a743ba07ef5fcc712cb9150e1154e2dd74f6b558c6ad2c813026c563de0f0bc49964611c9b231

data/CHANGELOG.md

@@ -1,7 +1,7 @@
-= Changelog Fidor API Schema
+#Changelog Fidor API Schema
 
 A more detailed view of the changes can be found in the [commit messages](https://github.com/fidor/fidor_schema/commits/)
 
-2014-10
+**2014-10**
 
-  * initial public release - ALPHA
+* initial public release - ALPHA

data/fidor_schema.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.5'
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'activesupport'
-  spec.add_development_dependency 'json_schema_tools', '>=0.2.6'
+  spec.add_development_dependency 'json_schema_tools', '>=0.3.0'
   spec.add_development_dependency 'activemodel' # required by above
   spec.add_development_dependency 'rake'
 
-end
+end

data/lib/fidor_schema_version.rb

@@ -1,5 +1,5 @@
 module Fidor
   class Schema
-    VERSION='0.1.18'
+    VERSION='0.2.0'
   end
 end

data/schema/v1.0/account.json

@@ -87,32 +87,39 @@
       "href" : "accounts/{id}"
     },
     {
-      "rel"  : "instances",
-      "href" : "accounts"
+      "rel"          : "instances",
+      "href"         : "accounts",
+      "targetSchema" : {
+        "$ref" : "./lists/accounts.json#"
+      }
     },
     {
-      "rel"  : "transactions",
-      "href" : "accounts/{id}/transactions"
+      "rel"          : "transactions",
+      "href"         : "accounts/{id}/transactions",
+      "targetSchema" : {
+        "$ref" : "./lists/transactions.json#"
+      }
     },
     {
-      "rel"  : "internal_transfers",
-      "href" : "accounts/{id}/internal_transfers"
+      "rel"          : "internal_transfers",
+      "href"         : "accounts/{id}/internal_transfers",
+      "targetSchema" : {
+        "$ref" : "./lists/internal_transfers.json#"
+      }
     },
     {
-      "rel"  : "sepa_credit_transfers",
-      "href" : "accounts/{id}/sepa_credit_transfers"
+      "rel"          : "sepa_credit_transfers",
+      "href"         : "accounts/{id}/sepa_credit_transfers",
+      "targetSchema" : {
+        "$ref" : "./lists/sepa_credit_transfers.json#"
+      }
     },
     {
-      "rel"  : "sepa_direct_debits",
-      "href" : "accounts/{id}/sepa_direct_debits"
-    },
-    {
-      "rel"  : "batch_transfers",
-      "href" : "accounts/{id}/batch_transfers"
-    },
-    {
-      "rel"  : "batch_direct_debit",
-      "href" : "accounts/{id}/batch_direct_debits"
+      "rel"          : "sepa_direct_debits",
+      "href"         : "accounts/{id}/sepa_direct_debits",
+      "targetSchema" : {
+        "$ref" : "./lists/sepa_direct_debits.json#"
+      }
     }
   ]
 }

data/schema/v1.0/base_types/base_types.json

@@ -4,18 +4,16 @@
       "description" : "Unique identifier of the object",
       "identity"    : true,
       "readonly"    : true,
-      "type"        : "integer"
+      "type"        : "string"
     },
     "account_id" : {
       "description" : "Fidor account the transaction belongs to.",
-      "type"        : "string",
-      "pattern"     : "\\d{8}"
+      "type"        : "string"
     },
     "user_id" : {
       "description" : "Identifies the user who created this object",
       "readonly"    : true,
-      "type"        : "string",
-      "pattern"     : "\\d{8}"
+      "type"        : "string"
     },
     "transaction_id" : {
       "description" : "Identifies a reference to a corresponding transaction",
@@ -65,7 +63,7 @@
     "bic" : {
       "description" : "BIC / Swift code of bank",
       "type"        : "string",
-      "pattern"     : "^([A-Z0-9]{8}|[A-Z0-9]{8})$",
+      "pattern"     : "^[A-Z0-9]{8,11}$",
       "maxLength"   : 11
     },
     "eref" : {
@@ -92,10 +90,10 @@
       "pattern"     : "^[A-Za-z0-9_\\.\\, &\\-\\/\\+\\*\\$\\%@üöäÜÖÄ߀]*$"
     },
     "amount" : {
-      "description" : "The transferred amount in account currency, two decimal places. Must be greater than 0 e.g. > 0",
-      "type"        : "number",
+      "description"      : "The transferred amount in account currency, two decimal places. Must be greater than 0 e.g. > 0",
+      "type"             : "number",
       "exclusiveMinimum" : true,
-      "minimum" : 0
+      "minimum"          : 0
     },
     "transaction_type" : {
       "description" : "Type of the transaction",

data/schema/v1.0/batch_direct_debit.json

@@ -1,4 +1,6 @@
 {
+  "NOTE"        : "THIS OBJECT IS NOT SUPPORTED IN THE CURRENT API VERSION",
+  "note"        : "this file is for future reference only!",
   "type"        : "object",
   "title"       : "Batch Direct Debit",
   "name"        : "batch_direct_debit",
@@ -53,7 +55,7 @@
         }
       }
     },
-    "number_of_debits" : {
+    "debit_count" : {
       "description" : "count of debits transactions received in this batch",
       "readonly"    : true,
       "type"        : "integer"

data/schema/v1.0/batch_transfer.json

@@ -1,4 +1,6 @@
 {
+  "NOTE"        : "THIS OBJECT IS NOT SUPPORTED IN THE CURRENT API VERSION",
+  "note"        : "this file is for future reference only!",
   "type"        : "object",
   "title"       : "Batch Transfer",
   "name"        : "batch_transfer",
@@ -87,7 +89,7 @@
         }
       }
     },
-    "number_of_transfers" : {
+    "transfer_count" : {
       "description" : "count of transfers (internal and sepa) transactions received in this batch",
       "readonly"    : true,
       "type"        : "integer"

data/schema/v1.0/customer.json

@@ -114,7 +114,7 @@
     "birthday" : {
       "description" : "Date of birth",
       "type"        : "string",
-      "format"      : "date-time",
+      "format"      : "date",
       "readonly"    : true
     },
     "is_verified" : {
@@ -193,12 +193,18 @@
       "href" : "customers/{id}"
     },
     {
-      "rel"  : "instances",
-      "href" : "customers"
+      "rel"          : "instances",
+      "href"         : "customers",
+      "targetSchema" : {
+        "$ref" : "./lists/customers.json#"
+      }
     },
     {
-      "rel"  : "accounts",
-      "href" : "customers/{id}/accounts"
+      "rel"          : "accounts",
+      "href"         : "customers/{id}/accounts",
+      "targetSchema" : {
+        "$ref" : "./lists/accounts.json#"
+      }
     }
   ]
 }

data/schema/v1.0/internal_transfer.json

@@ -126,6 +126,9 @@
           "description" : "Sort the results in ASC or DESC",
           "type"        : "string"
         }
+      },
+      "targetSchema" : {
+        "$ref" : "./lists/internal_transfers.json#"
       }
     },
     {

data/schema/v1.0/lists/accounts.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Accounts",
+  "name"        : "accounts",
+  "description" : "A paginated list of Account objects",
+  "properties"  : {
+    "accounts" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../account.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/batch_direct_debits.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Batch Direct Debits",
+  "name"        : "batch_direct_debits",
+  "description" : "A paginated list of Batch Direct Debit objects",
+  "properties"  : {
+    "batch_direct_debits" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../batch_direct_debit.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/batch_transfers.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Batch Transfers",
+  "name"        : "batch_transfers",
+  "description" : "A paginated list of Batch Transfer objects",
+  "properties"  : {
+    "batch_transfers" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../batch_transfer.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/collection.json

@@ -0,0 +1,20 @@
+{
+  "type"        : "object",
+  "title"       : "Collection",
+  "name"        : "collection",
+  "description" : "Pagination information for a list of returned object (not standalone)",
+  "properties"  : {
+    "current_page" : {
+      "type" : "integer"
+    },
+    "per_page" : {
+      "type" : "integer"
+    },
+    "total_entries" : {
+      "type" : "integer"
+    },
+    "total_pages" : {
+      "type" : "integer"
+    }
+  }
+}

data/schema/v1.0/lists/customers.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Customers",
+  "name"        : "customers",
+  "description" : "A paginated list of Customer objects",
+  "properties"  : {
+    "customers" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../customer.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/internal_transfers.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Internal Transfers",
+  "name"        : "internal_transfers",
+  "description" : "A paginated list of Internal Transfer objects",
+  "properties"  : {
+    "internal_transfers" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../internal_transfer.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/sepa_credit_transfers.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Credit Transfers",
+  "name"        : "sepa_credit_transfers",
+  "description" : "A paginated list of Sepa Credit Transfer objects",
+  "properties"  : {
+    "sepa_credit_transfers" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../sepa_credit_transfer.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/sepa_direct_debits.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Direct Debits",
+  "name"        : "sepa_direct_debits",
+  "description" : "A paginated list of Sepa Direct Debit objects",
+  "properties"  : {
+    "sepa_direct_debits" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../sepa_direct_debit.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/sepa_mandates.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Sepa Mandates",
+  "name"        : "sepa_mandates",
+  "description" : "A paginated list of Sepa Mandate objects",
+  "properties"  : {
+    "sepa_mandates" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../sepa_mandate.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/transactions.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Transactions",
+  "name"        : "transactions",
+  "description" : "A paginated list of Transaction objects",
+  "properties"  : {
+    "transactions" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../transaction.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/lists/users.json

@@ -0,0 +1,18 @@
+{
+  "type"        : "object",
+  "title"       : "Users",
+  "name"        : "users",
+  "description" : "A paginated list of User objects",
+  "properties"  : {
+    "users" : {
+      "type"  : "array",
+      "items" : {
+        "$ref" : "../user.json#"
+      }
+    },
+    "links"      : {},
+    "collection" : {
+      "$ref" : "./collection.json#"
+    }
+  }
+}

data/schema/v1.0/sepa_credit_transfer.json

@@ -112,6 +112,9 @@
           "description" : "Sort the results in ASC or DESC",
           "type"        : "string"
         }
+      },
+      "targetSchema" : {
+        "$ref" : "./lists/sepa_credit_transfers.json#"
       }
     },
     {

data/schema/v1.0/sepa_direct_debit.json

@@ -114,6 +114,9 @@
           "description" : "Sort the results in ASC or DESC",
           "type"        : "string"
         }
+      },
+      "targetSchema" : {
+        "$ref" : "./lists/sepa_direct_debits.json#"
       }
     },
     {

data/schema/v1.0/sepa_mandate.json

@@ -147,6 +147,9 @@
           "description" : "Sort the results in ASC or DESC",
           "type"        : "string"
         }
+      },
+      "targetSchema" : {
+        "$ref" : "./lists/sepa_mandates.json#"
       }
     },
     {

data/schema/v1.0/transaction.json

@@ -127,6 +127,9 @@
           ],
           "description" : "Sort the results in ASC or DESC",
           "type"        : "string"
+        },
+        "targetSchema" : {
+          "$ref" : "./lists/transactions.json#"
         }
       }
     }

data/schema/v1.0/transaction_type_details/internal_transfer_details.json

@@ -5,7 +5,7 @@
   "description" : "Remote account for a Fidor internal transfer",
   "properties"  : {
     "remote_account_id" : {
-      "$ref"     : "./base_types/base_types.json#definitions/account_id",
+      "$ref"     : "../base_types/base_types.json#definitions/account_id",
       "readonly" : true
     },
     "internal_transfer_id" : {

data/schema/v1.0/transaction_type_details/sepa_credit_transfer_details.json

@@ -16,11 +16,11 @@
       "maxLength"   : 70
     },
     "remote_iban" : {
-      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "$ref"     : "../base_types/base_types.json#definitions/iban",
       "readonly" : true
     },
     "remote_bic" : {
-      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "$ref"     : "../base_types/base_types.json#definitions/bic",
       "readonly" : true
     }
   }

data/schema/v1.0/transaction_type_details/sepa_direct_debit_details.json

@@ -5,11 +5,11 @@
   "description" : "Remote account information for a SEPA direct debit",
   "properties"  : {
     "remote_iban" : {
-      "$ref"     : "./base_types/base_types.json#definitions/iban",
+      "$ref"     : "../base_types/base_types.json#definitions/iban",
       "readonly" : true
     },
     "remote_bic" : {
-      "$ref"     : "./base_types/base_types.json#definitions/bic",
+      "$ref"     : "../base_types/base_types.json#definitions/bic",
       "readonly" : true
     },
     "mandate_id" : {
@@ -18,7 +18,7 @@
       "readonly"    : true
     },
     "eref" : {
-      "$ref"     : "./base_types/base_types.json#definitions/eref",
+      "$ref"     : "../base_types/base_types.json#definitions/eref",
       "readonly" : true
     }
   }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fidor_schema
 version: !ruby/object:Gem::Version
-  version: 0.1.18
+  version: 0.2.0
 platform: ruby
 authors:
 - Georg Leciejewski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-06 00:00:00.000000000 Z
+date: 2014-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.2.6
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
@@ -117,6 +117,17 @@ files:
 - schema/v1.0/customer.json
 - schema/v1.0/error.json
 - schema/v1.0/internal_transfer.json
+- schema/v1.0/lists/accounts.json
+- schema/v1.0/lists/batch_direct_debits.json
+- schema/v1.0/lists/batch_transfers.json
+- schema/v1.0/lists/collection.json
+- schema/v1.0/lists/customers.json
+- schema/v1.0/lists/internal_transfers.json
+- schema/v1.0/lists/sepa_credit_transfers.json
+- schema/v1.0/lists/sepa_direct_debits.json
+- schema/v1.0/lists/sepa_mandates.json
+- schema/v1.0/lists/transactions.json
+- schema/v1.0/lists/users.json
 - schema/v1.0/sepa_credit_transfer.json
 - schema/v1.0/sepa_direct_debit.json
 - schema/v1.0/sepa_mandate.json