search

code-corps / deprecated-code-corps-rails-api

Rails API for Code Corps.
https://codecorps.org
MIT License
25 stars 15 forks source link

Add documentation for Organization Memberships API #480

Closed begedin closed 8 years ago

begedin commented 8 years ago

Closes #409

begedin commented 8 years ago

@JoshSmith In several of my PRs, there's the debate of bundling up resources by "contains id, does not contain id". I think it may be worth doing, but the thing I'm unsure of, in this specific example, are cases like

### List all organization memberships for an organization [GET /organizations/:id/memberships]

Where does that go?

Do I keep it under 

## Organization Memberships [/organization_memberships]

Do I move it under the "Organizations" group?

I'll make it a point to update all my PRs, since I really did miss the grouping (mostly because the first endpoint being grouped are the categories and they seem to be completely wrong, using urls that do not exist, etc., but we do need to establish what to do with these, "special" endpoints, which do not follow the regular URL convention.

Also, what if a resource doesn't have the index/create actions and for example, only has those where an id needs to be specified? Do we still keep the grouping, or do we move it a level up?