Documentation ¶
Index ¶
- Constants
- type Server
- func (s *Server) APIKeyCreate(c *gin.Context)
- func (s *Server) APIKeyDelete(c *gin.Context)
- func (s *Server) APIKeyDetail(c *gin.Context)
- func (s *Server) APIKeyList(c *gin.Context)
- func (s *Server) APIKeyPermissions(c *gin.Context)
- func (s *Server) APIKeyUpdate(c *gin.Context)
- func (s *Server) Available() gin.HandlerFunc
- func (s *Server) Login(c *gin.Context)
- func (s *Server) MemberCreate(c *gin.Context)
- func (s *Server) MemberDelete(c *gin.Context)
- func (s *Server) MemberDetail(c *gin.Context)
- func (s *Server) MemberList(c *gin.Context)
- func (s *Server) MemberUpdate(c *gin.Context)
- func (s *Server) OrganizationDetail(c *gin.Context)
- func (s *Server) ProjectAPIKeyCreate(c *gin.Context)
- func (s *Server) ProjectAPIKeyList(c *gin.Context)
- func (s *Server) ProjectCreate(c *gin.Context)
- func (s *Server) ProjectDelete(c *gin.Context)
- func (s *Server) ProjectDetail(c *gin.Context)
- func (s *Server) ProjectList(c *gin.Context)
- func (s *Server) ProjectTopicCreate(c *gin.Context)
- func (s *Server) ProjectTopicList(c *gin.Context)
- func (s *Server) ProjectUpdate(c *gin.Context)
- func (s *Server) ProtectLogin(c *gin.Context)
- func (s *Server) Refresh(c *gin.Context)
- func (s *Server) Register(c *gin.Context)
- func (s *Server) Routes(router *gin.Engine) (err error)
- func (s *Server) SetEnsignClient(client pb.EnsignClient)
- func (s *Server) Setup() (err error)
- func (s *Server) Started() (err error)
- func (s *Server) Status(c *gin.Context)
- func (s *Server) Stop(context.Context) (err error)
- func (s *Server) TenantCreate(c *gin.Context)
- func (s *Server) TenantDelete(c *gin.Context)
- func (s *Server) TenantDetail(c *gin.Context)
- func (s *Server) TenantList(c *gin.Context)
- func (s *Server) TenantProjectCreate(c *gin.Context)
- func (s *Server) TenantProjectList(c *gin.Context)
- func (s *Server) TenantStats(c *gin.Context)
- func (s *Server) TenantUpdate(c *gin.Context)
- func (s *Server) TopicCreate(c *gin.Context)
- func (s *Server) TopicDelete(c *gin.Context)
- func (s *Server) TopicDetail(c *gin.Context)
- func (s *Server) TopicList(c *gin.Context)
- func (s *Server) TopicUpdate(c *gin.Context)
- func (s *Server) VerifyEmail(c *gin.Context)
Constants ¶
const ServiceName = "tenant"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Server ¶
Server implements the service.Service interface and provides handlers to respond to Tenant-specific API routes and requests.
func (*Server) APIKeyCreate ¶ added in v0.2.0
TODO: Implement by factoring out common code from ProjectAPIKeyCreate
func (*Server) APIKeyDelete ¶ added in v0.2.0
APIKeyDelete deletes an API key by forwarding the request to Quarterdeck.
Route: DELETE /v1/apikeys/:apiKeyID
func (*Server) APIKeyDetail ¶ added in v0.2.0
APIKeyDetail returns details about a specific API key.
Route: GET /v1/apikeys/:apiKeyID
func (*Server) APIKeyList ¶ added in v0.2.0
TODO: Implement by factoring out common code from ProjectAPIKeyCreate
func (*Server) APIKeyPermissions ¶ added in v0.5.0
APIKeyPermissions returns the API key permissions available to the user by forwarding the request to Quarterdeck.
Route: GET /v1/apikeys/permissions
func (*Server) APIKeyUpdate ¶ added in v0.2.0
APIKeyUpdate updates an API key by forwarding the request to Quarterdeck.
Route: PUT /v1/apikeys/:apiKeyID
func (*Server) Available ¶
func (s *Server) Available() gin.HandlerFunc
Available is middleware that uses healthy boolean to return a service unavailable http status code if the server is shutting down or in maintenance mode. This middleware must be fairly early on in the chain to ensure that complex handling does not slow the shutdown of the server.
func (*Server) Login ¶ added in v0.3.0
Login is a publically accessible endpoint that allows users to login into their account via Quarterdeck and receive access and refresh tokens for future requests.
Route: POST /v1/login
func (*Server) MemberCreate ¶ added in v0.2.0
MemberCreate adds a new member to an organization in the database and returns a 201 StatusCreated response.
Route: /member
func (*Server) MemberDelete ¶ added in v0.2.0
MemberDelete deletes a member from a user's request with a given ID and returns a 200 OK response instead of an an error response.
Route: /member/:memberID
func (*Server) MemberDetail ¶ added in v0.2.0
MemberDetail retrieves a summary detail of a member by its ID and returns a 200 OK response.
Route: /member/:memberID
func (*Server) MemberList ¶ added in v0.2.0
MemberList retrieves all members assigned to an organization and returns a 200 OK response.
Route: /member
func (*Server) MemberUpdate ¶ added in v0.2.0
MemberUpdate updates the record of a member with a given ID and returns a 200 OK response.
route: /member/:memberID
func (*Server) OrganizationDetail ¶ added in v0.4.0
Organization Detail fetches the details for an organization from Quarterdeck.
Route: GET /v1/organizations/:orgID
func (*Server) ProjectAPIKeyCreate ¶ added in v0.2.0
ProjectAPIKeyCreate creates a new API key in a project by forwarding the request to Quarterdeck.
Route: POST /v1/projects/:projectID/apikeys
func (*Server) ProjectAPIKeyList ¶ added in v0.2.0
ProjectAPIKeyList lists API keys in the specified project by forwarding the request to Quarterdeck.
Route: GET /v1/projects/:projectID/apikeys
func (*Server) ProjectCreate ¶ added in v0.2.0
ProjectCreate adds a new project to an organization in the database and returns a 201 StatusCreated response.
Route: /project
func (*Server) ProjectDelete ¶ added in v0.2.0
ProjectDelete deletes a project from a user's request with a given ID and returns a 200 OK response instead of an error response.
Route: /project/:projectID
func (*Server) ProjectDetail ¶ added in v0.2.0
ProjectDetail retrieves a summary detail of a project by its ID and returns a 200 OK response.
Route: /project/:projectID
func (*Server) ProjectList ¶ added in v0.2.0
ProjectList retrieves all projects assigned to an organization and returns a 200 OK response.
Route: /projects
func (*Server) ProjectTopicCreate ¶ added in v0.2.0
ProjectTopicCreate adds a topic to a project in the database and returns a 201 StatusCreated response.
Route: /projects/:projectID/topics
func (*Server) ProjectTopicList ¶ added in v0.2.0
ProjectTopicList retrieves all topics assigned to a project and returns a 200 OK response.
Route: /projects/:projectID/topics
func (*Server) ProjectUpdate ¶ added in v0.2.0
ProjectUpdate updates the record of a project with a given ID and returns a 200 OK response.
Route: /project/:projectID
func (*Server) ProtectLogin ¶ added in v0.2.0
ProtectLogin prepares the front-end for login by setting the double cookie tokens for CSRF protection.
func (*Server) Refresh ¶ added in v0.3.0
Refresh is a publicly accessible endpoint that allows users to refresh their access token using their refresh token. This enables frontend clients to provide a seamless login experience for the user.
Route: POST /v1/refresh
func (*Server) Register ¶ added in v0.3.0
Register is a publically accessible endpoint that allows new users to create an account via Quarterdeck by providing an email address and password.
Route: POST /v1/register
func (*Server) SetEnsignClient ¶ added in v0.5.0
func (s *Server) SetEnsignClient(client pb.EnsignClient)
Set an Ensign client on the server for testing.
func (*Server) Stop ¶ added in v0.4.0
Cleanup when the server is being shutdown. Note that in tests you should call Shutdown() to ensure the server stops and not this method.
func (*Server) TenantCreate ¶ added in v0.2.0
TenantCreate adds a new tenant to the database and returns a 201 StatusCreated response.
Route: /tenant
func (*Server) TenantDelete ¶ added in v0.2.0
TenantDelete deletes a tenant from a user's request with a given ID and returns a 200 OK response instead of an an error response.
Route: /tenant/:tenantID
func (*Server) TenantDetail ¶ added in v0.2.0
TenantDetail retrieves a summary detail of a tenant by its ID and returns a 200 OK response.
Route: /tenant/:tenantID
func (*Server) TenantList ¶ added in v0.2.0
TenantList retrieves all tenants assigned to an organization and returns a 200 OK response.
Route: /tenant
func (*Server) TenantProjectCreate ¶ added in v0.2.0
TenantProjectCreate adds a new tenant project to the database and returns a 201 StatusCreated response.
Route: /tenant/:tenantID/projects
func (*Server) TenantProjectList ¶ added in v0.2.0
TenantProjectList retrieves all projects assigned to a tenant and returns a 200 OK response.
Route: /tenant/:tenantID/projects
func (*Server) TenantStats ¶ added in v0.3.0
TenantStats is a statistical view endpoint which returns high level counts of resources associated with a single Tenant.
Route: /tenant/:tenantID/stats
func (*Server) TenantUpdate ¶ added in v0.2.0
TenantUpdate will update a tenants record and returns a 200 OK response.
Route: /tenant/:tenantID
func (*Server) TopicCreate ¶ added in v0.2.0
Route: /topics
func (*Server) TopicDelete ¶ added in v0.2.0
TopicDelete completely destroys a topic, removing the metadata in Trtl and as well as all of the data in Ensign. Because this is irreversible, the first call returns a confirmation token to the user. The user must provide this token in a subsequent request in order to confirm the deletion. Because this operation is asynchronous, the endpoint returns a 202 Accepted response.
Route: /topic/:topicID
func (*Server) TopicDetail ¶
TopicDetail retrieves a summary detail of a topic with a given ID and returns a 200 OK response.
Route: /topic/:topicID
func (*Server) TopicList ¶
TopicList retrieves all topics assigned to an organization and returns a 200 OK response.
Route: /topics
func (*Server) TopicUpdate ¶ added in v0.2.0
TopicUpdate updates the record of a topic with a given ID and returns a 200 OK response. The editable fields are the topic name and state, although the topic state can only be set to READONLY which archives the topic.
Route: /topic/:topicID
func (*Server) VerifyEmail ¶ added in v0.5.0
VerifyEmail is a publicly accessible endpoint that allows users to verify their email address by supplying a token that was sent to their email address. If the token has already been verified, this endpoint returns a 202 Accepted response.
Route: POST /v1/verify