Add spec for team CRUD endpoint #6
Conversation
spec.yml
Outdated
| @@ -85,6 +85,13 @@ x-resources: | |||
| - name: Shapes | |||
| description: | | |||
| "Shapes are vectors that each user can create and manage. These shapes can then be used in various ways within the Raster Foundry platform." | |||
| - name: Licenses | |||
| description: | | |||
| "A license is an official permission or permit to do, use, or own something." | |||
There was a problem hiding this comment.
I would add something like "Users can add licenses to the data they create and share in Raster Foundry to communicate to others if and how that data can be used".
spec.yml
Outdated
| in: body | ||
| required: true | ||
| schema: | ||
| $ref: '#/definitions/Team' |
There was a problem hiding this comment.
I think we should create a separate schema for team creation so that fields like createdAt, createdBy etc. don't show up in the spec as fields that can be set on creation. It would probably reflect the Team.Create case class in the API.
spec.yml
Outdated
| in: body | ||
| required: true | ||
| schema: | ||
| $ref: '#/definitions/Team' |
There was a problem hiding this comment.
We may also want to use a schema that better reflects the fields that the user can actually update. I'm sure we have other spots in this spec where we don't do this, but it's something that could be important if we want to move to spec based testing of the API.
aaronxsu
changed the title
spec.yml
Outdated
| @@ -85,6 +85,13 @@ x-resources: | |||
| - name: Shapes | |||
| description: | | |||
| "Shapes are vectors that each user can create and manage. These shapes can then be used in various ways within the Raster Foundry platform." | |||
| - name: Licenses | |||
| description: | | |||
| "A license is an official permission or permit to do, use, or own something." Users can add licenses to the data they create and share in Raster Foundry to communicate to others if and how that data can be used. | |||
There was a problem hiding this comment.
The quotes here don't enclose the whole blurb.
This PR adds spec for team CRUD endpoint implemented in raster-foundry/raster-foundry#3127
This is a part of
feature/platform-specMarked as WIP since there might be some clean up to do.
Closes #4