Skip to content

Commit 7fd04d4

Browse files
authored
docs: update ssh key description (#16602)
Fixes: #15672
1 parent 420855d commit 7fd04d4

File tree

4 files changed

+12
-7
lines changed

4 files changed

+12
-7
lines changed

coderd/apidoc/docs.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

coderd/apidoc/swagger.json

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

codersdk/gitsshkey.go

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,10 @@ type GitSSHKey struct {
1515
UserID uuid.UUID `json:"user_id" format:"uuid"`
1616
CreatedAt time.Time `json:"created_at" format:"date-time"`
1717
UpdatedAt time.Time `json:"updated_at" format:"date-time"`
18-
PublicKey string `json:"public_key"`
18+
// PublicKey is the SSH public key in OpenSSH format.
19+
// Example: "ssh-ed25519 AAAAC3NzaC1lZDI1NTE5AAAAID3OmYJvT7q1cF1azbybYy0OZ9yrXfA+M6Lr4vzX5zlp\n"
20+
// Note: The key includes a trailing newline (\n).
21+
PublicKey string `json:"public_key"`
1922
}
2023

2124
// GitSSHKey returns the user's git SSH public key.

docs/reference/api/schemas.md

Lines changed: 6 additions & 6 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy