10000 docs: applications and authorization by mtojek · Pull Request #5477 · coder/coder · GitHub
[go: up one dir, main page]
Skip to content

docs: applications and authorization #5477

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 15 commits into from
Dec 21, 2022
+830 −231
Merged

docs: applications and authorization #5477

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
15 commits
Select commit Hold shift + click to select a range
ffc1748
docs: Applications
mtojek Dec 20, 2022
d259c05
WIP
mtojek Dec 20, 2022
a26eac5
WIP
mtojek Dec 20, 2022
9950d35
WIP
mtojek Dec 20, 2022
fbbbf9a
Fix: consume
mtojek Dec 20, 2022
2f0b499
Fix: @Description
mtojek Dec 20, 2022
e5a4618
Fix
mtojek Dec 20, 2022
7c9002f
Merge branch 'main' into 3522-document-more-methods
mtojek Dec 20, 2022
e8286f6
Fix: s/none//g
mtojek Dec 21, 2022
60e0f27
Fix: godoc nice
mtojek Dec 21, 2022
74de5d4
Fix: description
mtojek Dec 21, 2022
095a463
Fix: It
mtojek Dec 21, 2022
4719a18
Fix: code sample trim empty line
mtojek Dec 21, 2022
ef213ac 8000
More fixes
mtojek Dec 21, 2022
12d904a
Fix: br
mtojek Dec 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Fix
  • Loading branch information
@mtojek
mtojek committed Dec 20, 2022
commit e5a46184ef809975fd87d0cea6829234db99ad66
1 change: 1 addition & 0 deletions coderd/apidoc/docs.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -790,6 +790,7 @@ const docTemplate = `{
}
},
"codersdk.CreateParameterRequest": {
"description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
"type": "object",
"required": [
"destination_scheme",
Expand Down
1 change: 1 addition & 0 deletions coderd/apidoc/swagger.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -694,6 +694,7 @@
}
},
"codersdk.CreateParameterRequest": {
"description": "CreateParameterRequest is a structure used to create a new parameter value for a scope.",
"type": "object",
"required": [
"destination_scheme",
Expand Down
2 changes: 1 addition & 1 deletion codersdk/parameters.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ type ParameterSchema struct {
ValidationContains []string `json:"validation_contains,omitempty"`
}

// CreateParameterRequest is used to create a new parameter value for a scope.
// @Description CreateParameterRequest is a structure used to create a new parameter value for a scope.
type CreateParameterRequest struct {
// CloneID allows copying the value of another parameter.
// The other param must be related to the same template_id for this to
Expand Down
4 changes: 3 additions & 1 deletion docs/api/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -117,6 +117,8 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
}
```

CreateParameterRequest is a structure used to create a new parameter value for a scope.

### Properties

| Name | Type | Required | Restrictions | Description |
Expand Down Expand Up @@ -168,7 +170,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| `display_name` | string | false | none | Display name is the displayed name of the template. |
| `icon` | string | false | none | Icon is a relative path or external URL that specifies<br>an icon to be displayed in the dashboard. |
| `name` | string | true | none | Name is the name of the template. |
| `parameter_values` | array of [codersdk.CreateParameterRequest](#codersdkcreateparameterrequest) | false | none | none |
| `parameter_values` | array of [codersdk.CreateParameterRequest](#codersdkcreateparameterrequest) | false | none | Parameter values is a structure used to create a new parameter value for a scope.] |
| `template_version_id` | string | true | none | Template version id is an in-progress or completed job to use as an initial version<br>of the template.<br><br>This is required on creation to enable a user-flow of validating a<br>template works. There is no reason the data-model cannot support empty<br>templates, but it doesn't make sense for users. |

## codersdk.DERPRegion
Expand Down
0