api

Documentation

Overview

Copyright (C) 2023 NHR@FAU, University Erlangen-Nuremberg. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file.

Index

• Variables
• type ApiReturnedUser
• type ApiTag
• type DeleteJobApiRequest
• type DeleteJobApiResponse
• type ErrorResponse
• type GetJobApiRequest
• type GetJobApiResponse
• type GetJobsApiResponse
• type JobMetricWithName
• type RestApi
  • func (api *RestApi) MountRoutes(r *mux.Router)
• type StartJobApiResponse
• type StopJobApiRequest
• type TagJobApiRequest
• type UpdateUserApiResponse

Variables

var SwaggerInfo = &swag.Spec{
	Version:          "1.0.0",
	Host:             "localhost:8080",
	BasePath:         "/api",
	Schemes:          []string{},
	Title:            "ClusterCockpit REST API",
	Description:      "API for batch job control.",
	InfoInstanceName: "swagger",
	SwaggerTemplate:  docTemplate,
	LeftDelim:        "{{",
	RightDelim:       "}}",
}

SwaggerInfo holds exported Swagger Info so clients can modify it

Types

type ApiReturnedUser

type ApiReturnedUser struct {
	Username string   `json:"username"`
	Name     string   `json:"name"`
	Roles    []string `json:"roles"`
	Email    string   `json:"email"`
	Projects []string `json:"projects"`
}

type ApiTag

type ApiTag struct {
	// Tag Type
	Type string `json:"type" example:"Debug"`
	Name string `json:"name" example:"Testjob"` // Tag Name
}

ApiTag model

type DeleteJobApiRequest

type DeleteJobApiRequest struct {
	JobId     *int64  `json:"jobId" validate:"required" example:"123000"` // Cluster Job ID of job
	Cluster   *string `json:"cluster" example:"fritz"`                    // Cluster of job
	StartTime *int64  `json:"startTime" example:"1649723812"`             // Start Time of job as epoch
}

DeleteJobApiRequest model

type DeleteJobApiResponse

type DeleteJobApiResponse struct {
	Message string `json:"msg"`
}

DeleteJobApiResponse model

type ErrorResponse

type ErrorResponse struct {
	// Statustext of Errorcode
	Status string `json:"status"`
	Error  string `json:"error"` // Error Message
}

ErrorResponse model

type GetJobApiRequest

type GetJobApiRequest []string

type GetJobApiResponse

type GetJobApiResponse struct {
	Meta *schema.Job
	Data []*JobMetricWithName
}

type GetJobsApiResponse

type GetJobsApiResponse struct {
	Jobs  []*schema.JobMeta `json:"jobs"`  // Array of jobs
	Items int               `json:"items"` // Number of jobs returned
	Page  int               `json:"page"`  // Page id returned
}

GetJobsApiResponse model

type JobMetricWithName

type JobMetricWithName struct {
	Name   string             `json:"name"`
	Scope  schema.MetricScope `json:"scope"`
	Metric *schema.JobMetric  `json:"metric"`
}

type RestApi

type RestApi struct {
	JobRepository   *repository.JobRepository
	Resolver        *graph.Resolver
	Authentication  *auth.Authentication
	MachineStateDir string
	RepositoryMutex sync.Mutex
}

func (*RestApi) MountRoutes

func (api *RestApi) MountRoutes(r *mux.Router)

type StartJobApiResponse

type StartJobApiResponse struct {
	// Database ID of new job
	DBID int64 `json:"id"`
}

StartJobApiResponse model

type StopJobApiRequest

type StopJobApiRequest struct {
	// Stop Time of job as epoch
	StopTime  int64           `json:"stopTime" validate:"required" example:"1649763839"`
	State     schema.JobState `json:"jobState" validate:"required" example:"completed"` // Final job state
	JobId     *int64          `json:"jobId" example:"123000"`                           // Cluster Job ID of job
	Cluster   *string         `json:"cluster" example:"fritz"`                          // Cluster of job
	StartTime *int64          `json:"startTime" example:"1649723812"`                   // Start Time of job as epoch
}

StopJobApiRequest model

type TagJobApiRequest

type TagJobApiRequest []*ApiTag

type UpdateUserApiResponse

type UpdateUserApiResponse struct {
	Message string `json:"msg"`
}

UpdateUserApiResponse model