summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authormo khan <mo@mokhan.ca>2014-02-22 00:10:33 -0700
committermo khan <mo@mokhan.ca>2014-02-22 00:10:33 -0700
commit1a937e5e8594a281b5071333476847371aff4049 (patch)
tree80427a1b4670e190bb5cc2eb83706c0b45c10111
parentb7935784e09235ca1bd760b2cfc7335731568d63 (diff)
review readme.
-rw-r--r--README.md13
1 files changed, 4 insertions, 9 deletions
diff --git a/README.md b/README.md
index 2bb9994..79654cf 100644
--- a/README.md
+++ b/README.md
@@ -69,11 +69,10 @@ A typical well license has the following structure (all fields are required):
WellLicense (aggregate root)
* belongs_to applicant
-* has_one well_type
-* has_one location
+* belongs_to well_type
+* belongs_to location
* issued_at
* expired_at
-* status
WellType (flyweight value object)
* id
@@ -85,7 +84,7 @@ Applicant
Location (value object)
* latitude
* longitude
-* township_name
+* township
LicenseStatus (flyweight, state)
* id
@@ -96,8 +95,4 @@ LicenseStatus (flyweight, state)
* GET /licenses/:guid - details of a single license
* GET /company/:guid/licenses - list of all active licences for company
* GET /company/:guid/licenses?township=:township - list of active licenses for township, for company.
-
-Start with a versioned api using urls cuz it's easy peasy. Won't worry
-about token auth at this point.
-
-What should i call this thing? hrmm....
+* GET /company/:guid/licenses?status=expired&township=:township - list of expired licenses for township, for company.