regenerated the docs

docs/README.md

@@ -62,12 +62,12 @@ PHP Packages:
 
 ### Installation
 
-See the [installation docs](INSTALL.md)
+See the [installation docs](Install.md)
 
 ### Update
 
-See the [update docs](UPDATE.md)
+See the [update docs](Update.md)
 
 ### API Specification
 
-See the [API spec](API_Specification.md)
+See the [API spec](Specification.md)

docs/API_Specification.md → docs/Specification.md

@@ -5,4 +5,5 @@ Below is a breakdown of ORM Core API spec.
 Be sure to check out the [Swagger docs](https://demo-orm.sage.edu/api/documentation) for interactive documentation.
 
 ---
+
 <table><tr><td>Path</td><td>Method</td><td>Summary</td></tr><tr><td>/accounts</td><td>GET</td><td>List accounts in a paginated format.</td></tr><tr><td>/accounts</td><td>DELETE</td><td>Delete an account.</td></tr><tr><td>/accounts</td><td>PATCH</td><td>Update an account.</td></tr><tr><td>/accounts</td><td>POST</td><td>Create/Update/Restore account.</td></tr><tr><td>/accounts/course</td><td>DELETE</td><td>Detach Course from Account.</td></tr><tr><td>/accounts/course</td><td>POST</td><td>Assign Course to Account.</td></tr><tr><td>/accounts/department</td><td>POST</td><td>Assign Department to Account.</td></tr><tr><td>/accounts/department</td><td>DELETE</td><td>Detach Department from Account.</td></tr><tr><td>/accounts/duty</td><td>POST</td><td>Assign Duty to Account.</td></tr><tr><td>/accounts/duty</td><td>DELETE</td><td>Detach Duty from Account.</td></tr><tr><td>/accounts/identifier/{identifier}</td><td>GET</td><td>Show an Account by Identifier</td></tr><tr><td>/accounts/load-status/code/{code}</td><td>GET</td><td>List accounts with the specified load status code in a paginated format.</td></tr><tr><td>/accounts/load-status/{id}</td><td>GET</td><td>List accounts with the specified load status in a paginated format.</td></tr><tr><td>/accounts/room</td><td>POST</td><td>Assign Room to Account.</td></tr><tr><td>/accounts/room</td><td>DELETE</td><td>Detach Room from Account.</td></tr><tr><td>/accounts/school</td><td>DELETE</td><td>Detach Account from School.</td></tr><tr><td>/accounts/school</td><td>POST</td><td>Assign Account to School.</td></tr><tr><td>/accounts/username/{username}</td><td>GET</td><td>Show an Account by Username</td></tr><tr><td>/accounts/{id}</td><td>GET</td><td>Show an Account by ID</td></tr><tr><td>/addresses</td><td>DELETE</td><td>Delete an Address.</td></tr><tr><td>/addresses</td><td>POST</td><td>Create Address.</td></tr><tr><td>/addresses</td><td>GET</td><td>List Addresses in a paginated format.</td></tr><tr><td>/addresses/{id}</td><td>GET</td><td>Show an Address by ID.</td></tr><tr><td>/alias-accounts</td><td>DELETE</td><td>Delete an alias account.</td></tr><tr><td>/alias-accounts</td><td>POST</td><td>Create/Update/Restore alias account.</td></tr><tr><td>/alias-accounts</td><td>GET</td><td>List alias accounts in a paginated format.</td></tr><tr><td>/alias-accounts/username/{username}</td><td>GET</td><td>Show an alias account by Username</td></tr><tr><td>/alias-accounts/{id}</td><td>GET</td><td>Show an alias account by ID</td></tr><tr><td>/auth</td><td>POST</td><td>Authenticate with API using Secret.</td></tr><tr><td>/auth/login</td><td>POST</td><td>Authenticate with API using credentials.</td></tr><tr><td>/auth/validate</td><td>GET</td><td>Verify authenticated session.</td></tr><tr><td>/buildings</td><td>GET</td><td>List Buildings in a paginated format.</td></tr><tr><td>/buildings</td><td>DELETE</td><td>Delete a building.</td></tr><tr><td>/buildings</td><td>POST</td><td>Create/Update/Restore Building.</td></tr><tr><td>/buildings/code/{code}</td><td>GET</td><td>Show a Building by Code.</td></tr><tr><td>/buildings/{id}</td><td>GET</td><td>Show a Building by ID.</td></tr><tr><td>/campuses</td><td>GET</td><td>List campuses in a paginated format.</td></tr><tr><td>/campuses</td><td>POST</td><td>Create/Update/Restore Campus.</td></tr><tr><td>/campuses</td><td>DELETE</td><td>Delete a Campus.</td></tr><tr><td>/campuses/code/{code}</td><td>GET</td><td>Show a Campus by Code.</td></tr><tr><td>/campuses/{id}</td><td>GET</td><td>Show a Campus by ID.</td></tr><tr><td>/countries</td><td>GET</td><td>List Countries in a paginated format.</td></tr><tr><td>/countries</td><td>DELETE</td><td>Delete a Country.</td></tr><tr><td>/countries</td><td>POST</td><td>Create/Update/Restore Country.</td></tr><tr><td>/countries/code/{code}</td><td>GET</td><td>Show a Country by Code.</td></tr><tr><td>/countries/{id}</td><td>GET</td><td>Show a Country by ID.</td></tr><tr><td>/courses</td><td>POST</td><td>Create/Update/Restore Course.</td></tr><tr><td>/courses</td><td>GET</td><td>List Courses in a paginated format.</td></tr><tr><td>/courses</td><td>DELETE</td><td>Delete a Course.</td></tr><tr><td>/courses/code/{code}</td><td>GET</td><td>Show a Course by Code.</td></tr><tr><td>/courses/{id}</td><td>GET</td><td>Show a Course by ID.</td></tr><tr><td>/departments</td><td>GET</td><td>List Departments in a paginated format.</td></tr><tr><td>/departments</td><td>POST</td><td>Create/Update/Restore Department.</td></tr><tr><td>/departments</td><td>DELETE</td><td>Delete a Department.</td></tr><tr><td>/departments/code/{code}</td><td>GET</td><td>Show a Department by Code.</td></tr><tr><td>/departments/{id}</td><td>GET</td><td>Show a Department by ID.</td></tr><tr><td>/duties</td><td>POST</td><td>Create/Update/Restore Duty.</td></tr><tr><td>/duties</td><td>GET</td><td>List Duties in a paginated format.</td></tr><tr><td>/duties</td><td>DELETE</td><td>Delete a Duty.</td></tr><tr><td>/duties/account/{id}</td><td>GET</td><td>Show a list of Duties that an account is a member of.</td></tr><tr><td>/duties/code/{code}</td><td>GET</td><td>Show a Duty by Code.</td></tr><tr><td>/duties/identifier/{identifier}</td><td>GET</td><td>Show a list of Duties that an account is a member of.</td></tr><tr><td>/duties/username/{username}</td><td>GET</td><td>Show a list of Duties that an account is a member of.</td></tr><tr><td>/duties/{id}</td><td>GET</td><td>Show a Duty by ID.</td></tr><tr><td>/emails</td><td>GET</td><td>List Emails in a paginated format.</td></tr><tr><td>/emails</td><td>POST</td><td>Create/Update/Restore Email.</td></tr><tr><td>/emails</td><td>DELETE</td><td>Delete an Email.</td></tr><tr><td>/emails/account/{id}</td><td>GET</td><td>Show all Email's owned by Account.</td></tr><tr><td>/emails/address/{address}</td><td>GET</td><td>Show a Email by Address.</td></tr><tr><td>/emails/identifier/{identifier}</td><td>GET</td><td>Show all Email's owned by Account by Identifier.</td></tr><tr><td>/emails/unverified</td><td>GET</td><td>List of unverified Emails in a paginated format.</td></tr><tr><td>/emails/unverified/account/{id}</td><td>GET</td><td>List of unverified Emails in a paginated format that are owned by the specified account.</td></tr><tr><td>/emails/username/{username}</td><td>GET</td><td>Show all Email's owned by Account by Username.</td></tr><tr><td>/emails/verified</td><td>GET</td><td>List of verified Emails in a paginated format.</td></tr><tr><td>/emails/verified/account/{id}</td><td>GET</td><td>List of verified Emails in a paginated format that are owned by the specified account.</td></tr><tr><td>/emails/{id}</td><td>GET</td><td>Show an Email by ID.</td></tr><tr><td>/load-status/code/{code}</td><td>GET</td><td>Show a Load Status by Code.</td></tr><tr><td>/load-statuses</td><td>DELETE</td><td>Delete a Load Status type.</td></tr><tr><td>/load-statuses</td><td>POST</td><td>Create/Update/Restore Load Status.</td></tr><tr><td>/load-statuses</td><td>GET</td><td>List the available Load Status types.</td></tr><tr><td>/load-statuses/{id}</td><td>GET</td><td>Show a Load Status by ID.</td></tr><tr><td>/mobile-carriers</td><td>POST</td><td>Create/Update/Restore Mobile Carrier.</td></tr><tr><td>/mobile-carriers</td><td>GET</td><td>List MobileCarriers in a paginated format.</td></tr><tr><td>/mobile-carriers</td><td>DELETE</td><td>Delete a Mobile Carrier.</td></tr><tr><td>/mobile-carriers/code/{code}</td><td>GET</td><td>Show a Mobile Carrier by Code.</td></tr><tr><td>/mobile-carriers/{id}</td><td>GET</td><td>Show a Mobile Carrier by ID.</td></tr><tr><td>/mobile-phones</td><td>POST</td><td>Create/Update/Restore Mobile Phone.</td></tr><tr><td>/mobile-phones</td><td>DELETE</td><td>Delete an Mobile Phone.</td></tr><tr><td>/mobile-phones</td><td>GET</td><td>List Mobile Phones in a paginated format.</td></tr><tr><td>/mobile-phones/account/{id}</td><td>GET</td><td>Show all Mobile Phone's owned by Account.</td></tr><tr><td>/mobile-phones/identifier/{identifier}</td><td>GET</td><td>Show all Mobile Phone's owned by Account by Identifier.</td></tr><tr><td>/mobile-phones/mobile-carrier/code/{code}</td><td>GET</td><td>List of Mobile Phones by Mobile Carrier Code.</td></tr><tr><td>/mobile-phones/mobile-carrier/id/{id}</td><td>GET</td><td>List of Mobile Phones by Mobile Carrier ID.</td></tr><tr><td>/mobile-phones/unverified</td><td>GET</td><td>List of unverified Mobile Phones in a paginated format.</td></tr><tr><td>/mobile-phones/unverified/account/{id}</td><td>GET</td><td>List of unverified Mobile Phones in a paginated format owned by an account.</td></tr><tr><td>/mobile-phones/username/{username}</td><td>GET</td><td>Show all Mobile Phone's owned by Account by Username.</td></tr><tr><td>/mobile-phones/verified</td><td>GET</td><td>List of verified Mobile Phones in a paginated format.</td></tr><tr><td>/mobile-phones/verified/account/{id}</td><td>GET</td><td>List of verified Mobile Phones that an account owns in a paginated format.</td></tr><tr><td>/mobile-phones/{id}</td><td>GET</td><td>Show an Mobile Phone by ID.</td></tr><tr><td>/rooms</td><td>GET</td><td>List Rooms in a paginated format.</td></tr><tr><td>/rooms</td><td>DELETE</td><td>Delete a Room.</td></tr><tr><td>/rooms</td><td>POST</td><td>Create/Update/Restore Room.</td></tr><tr><td>/rooms/code/{code}</td><td>GET</td><td>Show a Room by Code.</td></tr><tr><td>/rooms/{id}</td><td>GET</td><td>Show a Room by ID.</td></tr><tr><td>/school/code/{code}</td><td>GET</td><td>Show a School by Code.</td></tr><tr><td>/schools</td><td>GET</td><td>List Schools in a paginated format.</td></tr><tr><td>/schools</td><td>POST</td><td>Create/Update/Restore School.</td></tr><tr><td>/schools</td><td>DELETE</td><td>Delete a School.</td></tr><tr><td>/schools/{id}</td><td>GET</td><td>Show a School by ID.</td></tr><tr><td>/service-accounts</td><td>DELETE</td><td>Delete an service account.</td></tr><tr><td>/service-accounts</td><td>GET</td><td>List service accounts in a paginated format.</td></tr><tr><td>/service-accounts</td><td>POST</td><td>Create/Update/Restore service account.</td></tr><tr><td>/service-accounts/identifier/{identifier}</td><td>GET</td><td>Show an service account by Identifier</td></tr><tr><td>/service-accounts/username/{username}</td><td>GET</td><td>Show an service account by Username</td></tr><tr><td>/service-accounts/{id}</td><td>GET</td><td>Show an service account by ID</td></tr><tr><td>/states</td><td>DELETE</td><td>Delete a State.</td></tr><tr><td>/states</td><td>GET</td><td>List States in a paginated format.</td></tr><tr><td>/states</td><td>POST</td><td>Create/Update/Restore State.</td></tr><tr><td>/states/code/{code}</td><td>GET</td><td>Show a State by Code.</td></tr><tr><td>/states/{id}</td><td>GET</td><td>Show a State by ID.</td></tr><tr><td>/verify</td><td>POST</td><td>Verify Email or Mobile Phone.</td></tr><tr><td>/verify/{token}</td><td>GET</td><td>Verify Email or Mobile Phone.</td></tr></table>

package.json

@@ -4,7 +4,7 @@
     "prod": "gulp --production",
     "dev": "gulp watch",
     "spec": "yaml2json -p spec/swagger.yaml > storage/api-docs/api-docs.json",
-    "spec2md": "cp spec/header.md  docs/API_Specification.md && swagger-to-md -y spec/swagger.yaml >> docs/API_Specification.md"
+    "spec2md": "cp spec/header.md  docs/Specification.md && swagger-to-md -y spec/swagger.yaml >> docs/Specification.md"
   },
   "devDependencies": {
     "bootstrap-sass": "^3.3.7",

spec/header.md

@@ -5,3 +5,4 @@ Below is a breakdown of ORM Core API spec.
 Be sure to check out the [Swagger docs](https://demo-orm.sage.edu/api/documentation) for interactive documentation.
 
 ---
+