Merge pull request #168 from developmentseed/feature/add-orgs-to-docs

Add orgs to swagger docs

Author: kamicut

README.md

@@ -8,7 +8,10 @@
     <img src="https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square"
       alt="Standard" />
   </a>
-</div>
+  <a href="http://validator.swagger.io/validator/debug?url=https://raw.githubusercontent.com/developmentseed/osm-teams/master/docs/api.yml">
+    <img src="http://validator.swagger.io/validator?url=https://raw.githubusercontent.com/developmentseed/osm-teams/master/docs/api.yml">
+  </a>
+  </div>
 
 Check the beta 👉 <!-- markdownlint-disable MD034 -->https://mapping.team
 <!-- markdownlint-enable MD034 -->

app/manage/index.js

@@ -114,15 +114,15 @@ function manageRouter (nextApp) {
     return nextApp.render(req, res, '/profile')
   })
 
-  router.get('/teams/create', can('team:create'), (req, res) => {
+  router.get('/teams/create', can('public:authenticated'), (req, res) => {
     return nextApp.render(req, res, '/team-create', { id: req.params.id })
   })
 
   router.get('/teams/:id', can('team:view'), (req, res) => {
     return nextApp.render(req, res, '/team', { id: req.params.id })
   })
 
-  router.get('/teams/:id/edit', can('team:update'), (req, res) => {
+  router.get('/teams/:id/edit', can('team:edit'), (req, res) => {
     return nextApp.render(req, res, '/team-edit', { id: req.params.id })
   })
 

docs/api.md

@@ -23,9 +23,9 @@ create a client
 
 ##### Responses
 
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | oath 2.0 client | object |
+| Code | Description |
+| ---- | ----------- |
+| 200 | oath 2.0 client |
 
 ### /clients/{id}
 
@@ -107,7 +107,7 @@ update a team
 | Code | Description |
 | ---- | ----------- |
 | 200 | team updated |
-| 400 | error getting list of teams |
+| 400 | error updating team |
 
 #### DELETE
 ##### Summary:
@@ -232,3 +232,200 @@ Remove/Demote a moderator of a team. At least one moderator must exist for a tea
 | ---- | ----------- |
 | 200 | member was demoted from moderator |
 | 400 | error updating moderator relation |
+
+### /organizations
+
+#### POST
+##### Summary:
+
+create an organization
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | team |
+
+### /organizations/{id}
+
+#### GET
+##### Summary:
+
+get an organization
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | organization retrieved |
+| 400 | error getting list of organizations |
+
+#### PUT
+##### Summary:
+
+update an organization
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | team updated |
+| 400 | error updating organization |
+
+#### DELETE
+##### Summary:
+
+delete an organization
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | organization is deleted |
+| 400 | error deleting organization |
+
+### /organizations/{id}/addOwner/{osmId}
+
+#### PUT
+##### Summary:
+
+Assign/Promote a user to be an owner of an organization. More than one owner may exist concurrently. Owners can manage organizations of an organization.
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+|  |  |  | No | [OsmId](#osmid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | user is promoted to owner of organization |
+| 400 | error updating owner relation |
+
+### /organizations/{id}/removeOwner/{osmId}
+
+#### PUT
+##### Summary:
+
+Remove/Demote an owner of an organization. At least one owner must remain in the organization.
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+|  |  |  | No | [OsmId](#osmid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | user is demoted from owner |
+| 400 | error updating owner relation |
+
+### /organizations/{id}/addManager/{osmId}
+
+#### PUT
+##### Summary:
+
+Assign/Promote a user to be a manager of an organization. More than one manager may exist concurrently. Managers can create organizations for an organization but cannot update the organization.
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+|  |  |  | No | [OsmId](#osmid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | user is promoted to manager of organization |
+| 400 | error updating owner relation |
+
+### /organizations/{id}/removeManager/{osmId}
+
+#### PUT
+##### Summary:
+
+Remove/Demote manager of an organization. An org can have no managers.
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+|  |  |  | No | [OsmId](#osmid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | user is demoted from manager of organization |
+| 400 | error updating owner relation |
+
+### /organizations/{id}/teams
+
+#### POST
+##### Summary:
+
+Add a team to this organization. Only owners and managers can add new teams.
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | team was added successfully |
+| 400 | error creating team for organization |
+
+#### GET
+##### Summary:
+
+Get a list of teams for the specified organization
+
+
+##### Parameters
+
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ---- |
+|  |  |  | No | [OrgId](#orgid) |
+
+##### Responses
+
+| Code | Description |
+| ---- | ----------- |
+| 200 | A JSON array of team objects |
+| 400 | error getting list of teams |