rest

package
v0.2.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 15, 2024 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type User

type User struct {
	// ID is the user identifier.
	ID string `json:"id"`

	// Name is the user name.
	Login string `json:"login"`

	// PublicKey is the user's ssh public key.
	PublicKey string `json:"publicKey"`

	// PlayerID is the PlayerID associated with the user.
	PlayerID string `json:"playerID"`

	// Created is the time of the user's creation.
	Created arcade.Timestamp `json:"created"`

	// Updated is the time the user was last updated.
	Updated arcade.Timestamp `json:"updated"`
}

User holds a user's information, and is sent in a response.

type UserCreateRequest

type UserCreateRequest struct {
	UserRequest
}

UserCreateRequest is used to request a user be created.

type UserRequest

type UserRequest struct {
	// Login is the login id of the user.
	Login string `json:"login"`

	// PublicKey is the ssh public key of the user.
	PublicKey string `json:"publicKey"`

	// PlayerID is the ID of the player associated with the user.
	PlayerID string `json:"playerID"`
}

UserRequest is used to request a user be created or updated.

type UserResponse

type UserResponse struct {
	// User returns the information about a user.
	User User `json:"user"`
}

UserResponse returns a user.

type UserUpdateRequest

type UserUpdateRequest struct {
	UserRequest
}

UserUpdateRequest is used to request a user be updated.

type UsersResponse

type UsersResponse struct {
	// Users returns the information about multiple users.
	Users []User `json:"users"`
}

UsersResponse returns multiple users.

Directories

Path Synopsis
Package server provides primitives to interact with the openapi HTTP API.
Package server provides primitives to interact with the openapi HTTP API.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL