Skip to content
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

docs: clarify default fields examples #32

Merged
merged 2 commits into from
Oct 16, 2024
Merged

docs: clarify default fields examples #32

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84b77f4
docs: calirify default fields examples
agaudreault Oct 9, 2024
5ba7002
review
agaudreault Oct 16, 2024
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
6 changes: 3 additions & 3 deletions internal/backend/api.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ type CreateAccessRequestInput struct {

// CreateAccessRequestBody defines the create access response body.
type CreateAccessRequestBody struct {
RoleName string `json:"roleName" example:"custom-role" doc:"The role name to request."`
RoleName string `json:"roleName" example:"custom-role-template" doc:"The role template name to request."`
}

// CreateAccessRequestResponse defines the create access response.
Expand All @@ -78,9 +78,9 @@ type AccessRequestResponseBody struct {
Name string `json:"name" example:"some-accessrequest" doc:"The access request name."`
Namespace string `json:"namespace" example:"some-namespace" doc:"The access request namespace."`
Username string `json:"username" example:"[email protected]" doc:"The user associated with the access request."`
Permission string `json:"permission" example:"ReadOnly" doc:"The current permission description for the user."`
Permission string `json:"permission" example:"Operator Access" doc:"The permission description of the role associated to this access request."`
Role string `json:"role" example:"custom-role-template" doc:"The role template associated to this access request."`
RequestedAt string `json:"requestedAt,omitempty" example:"2024-02-14T18:25:50Z" doc:"The timestamp the access was requested (RFC3339 format)." format:"date-time"`
Role string `json:"role,omitempty" example:"DevOps" doc:"The current role the user is associated with."`
Status string `json:"status,omitempty" example:"GRANTED" doc:"The current access request status." enum:"REQUESTED,GRANTED,EXPIRED,DENIED,INVALID"`
ExpiresAt string `json:"expiresAt,omitempty" example:"2024-02-14T18:25:50Z" doc:"The timestamp the access will expire (RFC3339 format)." format:"date-time"`
Message string `json:"message,omitempty" example:"Click the link to see more details: ..." doc:"A human readeable description with details about the access request."`
Expand Down
Loading