shishantbiswas/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2026-06-02 20:48:20 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update ssh key description (#16602)

Browse Source 
Fixes: https://github.com/coder/coder/issues/15672
This commit is contained in:
Marcin Tojek
2025-02-18 13:06:19 +01:00
committed by GitHub
parent 420855dc55
commit 7fd04d4c54
4 changed files with 12 additions and 7 deletions
Download Patch File Download Diff File Expand all files Collapse all files
coderd/apidoc/docs.go
Generated
+1
View File
@@ -11800,6 +11800,7 @@ const docTemplate = `{
"format": "date-time" "format": "date-time"
}, },
"public_key": { "public_key": {
"description": "PublicKey is the SSH public key in OpenSSH format.\nExample: \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\\n\"\nNote: The key includes a trailing newline (\\n).",
"type": "string" "type": "string"
}, },
"updated_at": { "updated_at": {
coderd/apidoc/swagger.json
Generated
+1
View File
@@ -10591,6 +10591,7 @@
"format": "date-time" "format": "date-time"
}, },
"public_key": { "public_key": {
"description": "PublicKey is the SSH public key in OpenSSH format.\nExample: \"ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\\n\"\nNote: The key includes a trailing newline (\\n).",
"type": "string" "type": "string"
}, },
"updated_at": { "updated_at": {
codersdk/gitsshkey.go
+4 -1
View File
@@ -15,7 +15,10 @@ type GitSSHKey struct {
UserID uuid.UUID `json:"user_id" format:"uuid"` UserID uuid.UUID `json:"user_id" format:"uuid"`
CreatedAt time.Time `json:"created_at" format:"date-time"` CreatedAt time.Time `json:"created_at" format:"date-time"`
UpdatedAt time.Time `json:"updated_at" format:"date-time"` UpdatedAt time.Time `json:"updated_at" format:"date-time"`
PublicKey string `json:"public_key"` // PublicKey is the SSH public key in OpenSSH format.
// Example: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\n"
// Note: The key includes a trailing newline (\n).
PublicKey string `json:"public_key"`
} }
// GitSSHKey returns the user's git SSH public key. // GitSSHKey returns the user's git SSH public key.
docs/reference/api/schemas.md
Generated
+6 -6
View File
@@ -3090,12 +3090,12 @@ Git clone makes use of this by parsing the URL from: 'Username for "https://gith
### Properties ### Properties
| Name | Type | Required | Restrictions | Description | | Name | Type | Required | Restrictions | Description |
|--------------|--------|----------|--------------|-------------| |--------------|--------|----------|--------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `created_at` | string | false | | | | `created_at` | string | false | | |
| `public_key` | string | false | | | | `public_key` | string | false | | Public key is the SSH public key in OpenSSH format. Example: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\n" Note: The key includes a trailing newline (\n). |
| `updated_at` | string | false | | | | `updated_at` | string | false | | |
| `user_id` | string | false | | | | `user_id` | string | false | | |
## codersdk.Group ## codersdk.Group