Documentation
¶
Overview ¶
Package api contains the REST and gRPC API.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Index ¶
- func ServeStaticFile(mux *http.ServeMux)
- func ServeSwagger(mux *http.ServeMux)
- func VersionHandler(w http.ResponseWriter, r *http.Request)
- type HealthService
- type InfoService
- type LeagueService
- func (ls *LeagueService) Create(ctx context.Context, request *v1beta.CreateLeagueRequest) (*v1beta.CreateLeagueResponse, error)
- func (ls *LeagueService) Get(ctx context.Context, request *v1beta.GetLeagueRequest) (*v1beta.GetLeagueResponse, error)
- func (ls *LeagueService) List(ctx context.Context, request *v1beta.GetLeaguesRequest) (*v1beta.GetLeaguesResponse, error)
- type VersionResponse
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ServeSwagger ¶
ServeSwagger expose files in third_party/swagger-ui/ on <host>/swagger-ui
func VersionHandler ¶
func VersionHandler(w http.ResponseWriter, r *http.Request)
Types ¶
type HealthService ¶
type HealthService struct {
Authentication auth.Authentication
HealthUser string
HealthKey string
URI string
Services []string
}
func NewHealthService ¶
func NewHealthService(conf *config.Configuration, uri string, services []string) (*HealthService, error)
func (*HealthService) Status ¶
func (service *HealthService) Status(ctx context.Context, req *health.StatusRequest) (*health.StatusResponse, error)
type InfoService ¶
type InfoService struct {
Version string
}
func NewInfoService ¶
func NewInfoService(conf *config.Configuration) *InfoService
func (*InfoService) Get ¶
func (service *InfoService) Get(ctx context.Context, req *info.GetInfoRequest) (*info.GetInfoResponse, error)
type LeagueService ¶
func NewLeagueService ¶
func NewLeagueService(backend storage.Backend) *LeagueService
func (*LeagueService) Create ¶
func (ls *LeagueService) Create(ctx context.Context, request *v1beta.CreateLeagueRequest) (*v1beta.CreateLeagueResponse, error)
func (*LeagueService) Get ¶
func (ls *LeagueService) Get(ctx context.Context, request *v1beta.GetLeagueRequest) (*v1beta.GetLeagueResponse, error)
func (*LeagueService) List ¶
func (ls *LeagueService) List(ctx context.Context, request *v1beta.GetLeaguesRequest) (*v1beta.GetLeaguesResponse, error)
type VersionResponse ¶
type VersionResponse struct {
Version string `json:"version"`
}
Source Files
¶
Click to show internal directories.
Click to hide internal directories.