docs: describe mutually exclusive create workspace template fields (#12834)

* docs: describe mutually exclusive create workspace template fields

Ideally we could do this in the OpenAPI spec, but there is no first
class "mutually exclusive" feature in OpenAPI. So in lieu of something
more complex, or changing our struct/validation, a description comment
should suffice.

* chore: Add description to code sample as well
This commit is contained in:
Steven Masley
2024-04-02 10:11:24 -05:00
committed by GitHub
parent 5137433123
commit b5b5c37d03
6 changed files with 18 additions and 0 deletions
+5
View File
@@ -14,6 +14,11 @@ curl -X POST http://coder-server:8080/api/v2/organizations/{organization}/member
`POST /organizations/{organization}/members/{user}/workspaces`
Create a new workspace using a template. The request must
specify either the Template ID or the Template Version ID,
not both. If the Template ID is specified, the active version
of the template will be used.
> Body parameter
```json