swagger

package
Version: v0.16.4 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2021 License: GPL-3.0 Imports: 20 Imported by: 0

README

Go API client for swagger

No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)

Overview

This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.

  • API version: 0.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.go.GoClientCodegen

Installation

Put the package under your project folder and add the following in import:

import "./swagger"

Documentation for API Endpoints

All URIs are relative to /api

Class Method HTTP request Description
AttachmentApi CreateAttachment Post /attachments Create a new attachment on a log
AttachmentApi GetAttachment Get /attachments/{attachmentId} Get one specific attachment
DefaultApi GetDeployInformation Get /status Get deploy information
DefaultApi GetServerInformation Get / Get server information
FlpApi CreateFlp Post /flps Adds a new flp
FlpApi GetFlpById Get /flps/{flpId} Gets a flp by Id
FlpApi ListFlps Get /flps List all flps
FlpApi UpdateFlp Patch /flps/{flpId} Update an existing flp
LogApi CreateLog Post /logs Adds a new log
LogApi GetLogAttachment Get /logs/{logId}/attachments/{attachmentId} Get one specific attachment associated with a log
LogApi GetLogById Get /logs/{logId} Gets a log by Id
LogApi GetLogTree Get /logs/{logId}/tree Get the Log tree for a given Log
LogApi ListLogAttachments Get /logs/{logId}/attachments Get all attachments associated with a log
LogApi ListLogs Get /logs List all logs
LogApi ListTagsByLogId Get /logs/{logId}/tags Lists all tags associated with a log
RunApi CreateRun Post /runs Creates a run
RunApi EndRun Patch /runs/{runId} Updates certain fields of a run
RunApi GetRunById Get /runs/{runId} Gets a run by Id
RunApi ListRuns Get /runs List all runs
SubsystemApi CreateSubsystem Post /subsystems Adds a new subsystem
SubsystemApi DeleteSubsystem Delete /subsystems/{subsystemId} Deletes a subsystem by Id
SubsystemApi GetSubsystem Get /subsystems/{subsystemId} Get a subsystem by Id
SubsystemApi ListSubsystems Get /subsystems List all subsystems
TagApi CreateTag Post /tags Adds a new tag
TagApi DeleteTagById Delete /tags/{tagId} Deletes a tag by Id
TagApi GetLogsByTagId Get /tags/{tagId}/logs Gets all logs with this tag id
TagApi GetTagById Get /tags/{tagId} Gets a tag by Id
TagApi ListTags Get /tags List all tags

Documentation For Models

Documentation For Authorization

ApiKeyAuth

  • Type: API key

Example

auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
	Key: "APIKEY",
	Prefix: "Bearer", // Omit if not necessary.
})
r, err := client.Service.Operation(auth, args)

Author

Documentation

Overview

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

* ALICE Bookkeeping * * No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) * * API version: 0.0.0 * Generated by: Swagger Codegen (https://github.com/swagger-api/swagger-codegen.git)

Index

Constants

This section is empty.

Variables

View Source
var (
	// ContextOAuth2 takes a oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

Types

type APIClient

type APIClient struct {
	AttachmentApi *AttachmentApiService

	DefaultApi *DefaultApiService

	FlpApi *FlpApiService

	LogApi *LogApiService

	RunApi *RunApiService

	SubsystemApi *SubsystemApiService

	TagApi *TagApiService
	// contains filtered or unexported fields
}

APIClient manages communication with the ALICE Bookkeeping API v0.0.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) ChangeBasePath

func (c *APIClient) ChangeBasePath(path string)

Change base path to allow switching to mocks

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the swagger operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

type ApiInformation

type ApiInformation struct {
	// Name of the API
	Name string `json:"name"`
	// Version of the API
	Version string `json:"version"`
}

API information

type ArrayOfAttachmentsResponse

type ArrayOfAttachmentsResponse struct {
	Data *[]Attachment `json:"data"`
}

Response containing multiple attachments.

type ArrayOfFlpsResponse

type ArrayOfFlpsResponse struct {
	Data *[]Flp                   `json:"data"`
	Meta *ArrayOfFlpsResponseMeta `json:"meta,omitempty"`
}

Response containing multiple flps.

type ArrayOfFlpsResponseMeta

type ArrayOfFlpsResponseMeta struct {
	Page *PaginationMeta `json:"page"`
}

The metadata related to an array of flps response.

type ArrayOfLogsResponse

type ArrayOfLogsResponse struct {
	Data *[]Log                   `json:"data"`
	Meta *ArrayOfLogsResponseMeta `json:"meta,omitempty"`
}

Response containing multiple logs.

type ArrayOfLogsResponseMeta

type ArrayOfLogsResponseMeta struct {
	Page *PaginationMeta `json:"page"`
}

The metadata related to an array of logs response.

type ArrayOfRunsResponse

type ArrayOfRunsResponse struct {
	Data *[]Run                   `json:"data"`
	Meta *ArrayOfRunsResponseMeta `json:"meta,omitempty"`
}

Response containing multiple runs.

type ArrayOfRunsResponseMeta

type ArrayOfRunsResponseMeta struct {
	Page *PaginationMeta `json:"page"`
}

The metadata related to an array of runs response.

type ArrayOfSubsystemsResponse

type ArrayOfSubsystemsResponse struct {
	Data *[]Subsystem                   `json:"data"`
	Meta *ArrayOfSubsystemsResponseMeta `json:"meta,omitempty"`
}

Response containing multiple subsystems.

type ArrayOfSubsystemsResponseMeta

type ArrayOfSubsystemsResponseMeta struct {
	Page *PaginationMeta `json:"page"`
}

The metadata related to an array of subsystems response.

type ArrayOfTagsResponse

type ArrayOfTagsResponse struct {
	Data *[]Tag `json:"data"`
}

Response containing multiple tags.

type Attachment

type Attachment struct {
	// Unix timestamp when this entity was created.
	CreatedAt    int64  `json:"createdAt,omitempty"`
	Encoding     string `json:"encoding,omitempty"`
	FileName     string `json:"fileName,omitempty"`
	Id           int64  `json:"id"`
	LogId        int64  `json:"logId,omitempty"`
	MimeType     string `json:"mimeType,omitempty"`
	OriginalName string `json:"originalName,omitempty"`
	Path         string `json:"path,omitempty"`
	Size         int64  `json:"size,omitempty"`
	// Unix timestamp when this entity was created.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Describes metadata of an attachment.

type AttachmentApiService

type AttachmentApiService service

func (*AttachmentApiService) CreateAttachment

AttachmentApiService Create a new attachment on a log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return ArrayOfAttachmentsResponse

func (*AttachmentApiService) GetAttachment

func (a *AttachmentApiService) GetAttachment(ctx context.Context, attachmentId int64) (ArrayOfAttachmentsResponse, *http.Response, error)

AttachmentApiService Get one specific attachment

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param attachmentId The id of the attached to retrieve

@return ArrayOfAttachmentsResponse

type AttachmentResponse

type AttachmentResponse struct {
	Data *Attachment `json:"data"`
}

Response containing a single attachment.

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type Configuration

type Configuration struct {
	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	HTTPClient    *http.Client
}

func NewConfiguration

func NewConfiguration() *Configuration

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

type CreateAttachments

type CreateAttachments struct {
	Attachments *[]Attachment `json:"attachments,omitempty"`
}

Describes an attachment

type CreateFlp

type CreateFlp struct {
	Name      string `json:"name"`
	Hostname  string `json:"hostname"`
	RunNumber int64  `json:"runNumber,omitempty"`
}

Describes an flp

type CreateLog

type CreateLog struct {
	Attachments *[]Attachment `json:"attachments,omitempty"`
	ParentLogId int64         `json:"parentLogId,omitempty"`
	Text        string        `json:"text"`
	Title       string        `json:"title"`
	RunNumbers  string        `json:"runNumbers,omitempty"`
}

Describes an intervention or an event that happened.

type CreateSubsystem

type CreateSubsystem struct {
	// The label value of the subsystem.
	Text string `json:"text"`
}

A label attached to something for the purpose of identification.

type CreateTag

type CreateTag struct {
	// The label value of the tag.
	Text string `json:"text"`
}

A label attached to something for the purpose of identification.

type DefaultApiService

type DefaultApiService service

func (*DefaultApiService) GetDeployInformation

func (a *DefaultApiService) GetDeployInformation(ctx context.Context) (DeployInformation, *http.Response, error)

DefaultApiService Get deploy information

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return DeployInformation

func (*DefaultApiService) GetServerInformation

func (a *DefaultApiService) GetServerInformation(ctx context.Context) (ApiInformation, *http.Response, error)

DefaultApiService Get server information

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ApiInformation

type DeployInformation

type DeployInformation struct {
	// The number of seconds that the server is online.
	Age float64 `json:"age"`
	// The unix timestamp of the moment that the the server went online.
	Start int64 `json:"start"`
}

Deploy information

type Entity

type Entity struct {
	// Unix timestamp when this entity was created.
	CreatedAt int64 `json:"createdAt,omitempty"`
	Id        int64 `json:"id"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Base entity.

type ErrorSource

type ErrorSource struct {
	// A pointer to the associated entity in the request document.
	Pointer string `json:"pointer,omitempty"`
}

An object containing references to the source of the error.

type Errors

type Errors struct {
	// A list of Error objects.
	Errors []ModelError `json:"errors"`
}

A list of Error objects.

type FilterLogsCreatedOptions

type FilterLogsCreatedOptions struct {
	// The earliest allowed unix timestamp for the fetched data.
	From int64 `json:"from,omitempty"`
	// The latest allowed unix timestamp for the fetched data.
	To int64 `json:"to,omitempty"`
}

Specifies the creation time related filter requirements for a request.

type FilterLogsOptions

type FilterLogsOptions struct {
	// Name of the author.
	Author    string                    `json:"author,omitempty"`
	Created   *FilterLogsCreatedOptions `json:"created,omitempty"`
	Origin    *LogOrigin                `json:"origin,omitempty"`
	ParentLog int64                     `json:"parentLog,omitempty"`
	RootLog   int64                     `json:"rootLog,omitempty"`
	Tag       *FilterLogsTagOptions     `json:"tag,omitempty"`
	Title     string                    `json:"title,omitempty"`
}

Specifies the log related filter requirements for a request.

type FilterLogsTagOptions

type FilterLogsTagOptions struct {
	// The operation indicating the relation between the data.
	Operation string `json:"operation"`
	Values    string `json:"values"`
}

Specifies the tag related filter requirements for a request.

type Flp

type Flp struct {
	BytesEquipmentReadOut int64 `json:"bytesEquipmentReadOut"`
	BytesFairMQReadOut    int64 `json:"bytesFairMQReadOut"`
	BytesProcessed        int64 `json:"bytesProcessed"`
	BytesRecordingReadOut int64 `json:"bytesRecordingReadOut"`
	// Unix timestamp when this entity was created.
	CreatedAt   int64  `json:"createdAt,omitempty"`
	Hostname    string `json:"hostname"`
	Id          int64  `json:"id"`
	NTimeframes int64  `json:"nTimeframes"`
	Name        string `json:"name"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Describes an intervention or an event that happened.

type FlpApiService

type FlpApiService service

func (*FlpApiService) CreateFlp

func (a *FlpApiService) CreateFlp(ctx context.Context, body CreateFlp) (LogResponse, *http.Response, error)

FlpApiService Adds a new flp

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return LogResponse

func (*FlpApiService) GetFlpById

func (a *FlpApiService) GetFlpById(ctx context.Context, flpId int64) (FlpResponse, *http.Response, error)

FlpApiService Gets a flp by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param flpId The id of the flp to retrieve

@return FlpResponse

func (*FlpApiService) ListFlps

FlpApiService List all flps

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArrayOfFlpsResponse

func (*FlpApiService) UpdateFlp

func (a *FlpApiService) UpdateFlp(ctx context.Context, body UpdateFlp, flpId int64) (FlpResponse, *http.Response, error)

FlpApiService Update an existing flp

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body
* @param flpId The id of the flp to retrieve

@return FlpResponse

type FlpResponse

type FlpResponse struct {
	Data *Flp `json:"data"`
}

Response containing a single flp.

type FlpSortOptions

type FlpSortOptions struct {
	Id *SortOrder `json:"id,omitempty"`
}

Specifies the sorting requirements of a flp request.

type GenericSwaggerError

type GenericSwaggerError struct {
	// contains filtered or unexported fields
}

GenericSwaggerError Provides access to the body, error and model on returned errors.

func (GenericSwaggerError) Body

func (e GenericSwaggerError) Body() []byte

Body returns the raw bytes of the response

func (GenericSwaggerError) Error

func (e GenericSwaggerError) Error() string

Error returns non-empty string if there was an error.

func (GenericSwaggerError) Model

func (e GenericSwaggerError) Model() interface{}

Model returns the unpacked model of the error

type Log

type Log struct {
	Attachments *[]Attachment `json:"attachments,omitempty"`
	Author      *User         `json:"author"`
	// Unix timestamp when this entity was created.
	CreatedAt   int64      `json:"createdAt,omitempty"`
	Id          int64      `json:"id"`
	Origin      *LogOrigin `json:"origin"`
	ParentLogId int64      `json:"parentLogId"`
	Replies     int64      `json:"replies,omitempty"`
	RootLogId   int64      `json:"rootLogId"`
	// Array of minified Run objects.
	Runs       []LogRuns    `json:"runs,omitempty"`
	Subsystems *[]Subsystem `json:"subsystems,omitempty"`
	Subtype    *LogSubtype  `json:"subtype"`
	Tags       *[]Tag       `json:"tags,omitempty"`
	Text       string       `json:"text"`
	Title      string       `json:"title"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Describes an intervention or an event that happened.

type LogApiService

type LogApiService service

func (*LogApiService) CreateLog

func (a *LogApiService) CreateLog(ctx context.Context, body CreateLog) (LogResponse, *http.Response, error)

LogApiService Adds a new log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return LogResponse

func (*LogApiService) GetLogAttachment

func (a *LogApiService) GetLogAttachment(ctx context.Context, logId int64, attachmentId int64) (AttachmentResponse, *http.Response, error)

LogApiService Get one specific attachment associated with a log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param logId The id of the log to retrieve
* @param attachmentId The id of the attached to retrieve

@return AttachmentResponse

func (*LogApiService) GetLogById

func (a *LogApiService) GetLogById(ctx context.Context, logId int64) (LogResponse, *http.Response, error)

LogApiService Gets a log by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param logId The id of the log to retrieve

@return LogResponse

func (*LogApiService) GetLogTree

func (a *LogApiService) GetLogTree(ctx context.Context, logId int64) (LogTreeResponse, *http.Response, error)

LogApiService Get the Log tree for a given Log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param logId The id of the log to retrieve

@return LogTreeResponse

func (*LogApiService) ListLogAttachments

func (a *LogApiService) ListLogAttachments(ctx context.Context, logId int64) (ArrayOfAttachmentsResponse, *http.Response, error)

LogApiService Get all attachments associated with a log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param logId The id of the log to retrieve

@return ArrayOfAttachmentsResponse

func (*LogApiService) ListLogs

LogApiService List all logs

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArrayOfLogsResponse

func (*LogApiService) ListTagsByLogId

func (a *LogApiService) ListTagsByLogId(ctx context.Context, logId int64) (ArrayOfTagsResponse, *http.Response, error)

LogApiService Lists all tags associated with a log

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param logId The id of the log to retrieve

@return ArrayOfTagsResponse

type LogOrigin

type LogOrigin string

LogOrigin : Type of creator.

const (
	HUMAN_LogOrigin   LogOrigin = "human"
	PROCESS_LogOrigin LogOrigin = "process"
)

List of LogOrigin

type LogResponse

type LogResponse struct {
	Data *Log `json:"data"`
}

Response containing a single log.

type LogRuns

type LogRuns struct {
	Id        int64 `json:"id"`
	RunNumber int64 `json:"runNumber"`
}

Minified Run object.

type LogSortOptions

type LogSortOptions struct {
	Author    *SortOrder `json:"author,omitempty"`
	CreatedAt *SortOrder `json:"createdAt,omitempty"`
	Id        *SortOrder `json:"id,omitempty"`
	Tags      *SortOrder `json:"tags,omitempty"`
	Title     *SortOrder `json:"title,omitempty"`
}

Specifies the sorting requirements of a log request.

type LogSubtype

type LogSubtype string

LogSubtype : The subtype of a Log.

const (
	RUN_LogSubtype          LogSubtype = "run"
	SUBSYSTEM_LogSubtype    LogSubtype = "subsystem"
	ANNOUNCEMENT_LogSubtype LogSubtype = "announcement"
	INTERVENTION_LogSubtype LogSubtype = "intervention"
	COMMENT_LogSubtype      LogSubtype = "comment"
)

List of LogSubtype

type LogTree

type LogTree struct {
	Attachments *[]Attachment `json:"attachments,omitempty"`
	Author      *User         `json:"author"`
	Children    *[]LogTree    `json:"children"`
	// Unix timestamp when this entity was created.
	CreatedAt   int64      `json:"createdAt,omitempty"`
	Id          int64      `json:"id"`
	Origin      *LogOrigin `json:"origin"`
	ParentLogId int64      `json:"parentLogId"`
	Replies     int64      `json:"replies,omitempty"`
	RootLogId   int64      `json:"rootLogId"`
	// Array of minified Run objects.
	Runs       []LogRuns    `json:"runs,omitempty"`
	Subsystems *[]Subsystem `json:"subsystems,omitempty"`
	Subtype    *LogSubtype  `json:"subtype"`
	Tags       *[]Tag       `json:"tags,omitempty"`
	Text       string       `json:"text"`
	Title      string       `json:"title"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Describes an intervention or an event that happened.

type LogTreeResponse

type LogTreeResponse struct {
	Data *LogTree `json:"data"`
}

Response containing a single log tree.

type ModelError

type ModelError struct {
	// A human-readable explanation specific to this occurrence of the problem.
	Detail string       `json:"detail,omitempty"`
	Source *ErrorSource `json:"source,omitempty"`
	// The HTTP status code applicable to this problem.
	Status string `json:"status"`
	// A short, human-readable summary of the problem.
	Title string `json:"title"`
}

An Error object.

type PaginationMeta

type PaginationMeta struct {
	// The total number of pages which contain data.
	PageCount int64 `json:"pageCount"`
	// The total number of elements in the collection
	TotalCount int64 `json:"totalCount"`
}

The metadata related to pagination.

type PaginationOptions

type PaginationOptions struct {
	Limit  int32 `json:"limit,omitempty"`
	Offset int64 `json:"offset,omitempty"`
}

Specifies the pagination requirements of a request.

type Run

type Run struct {
	ActivityId   string `json:"activityId,omitempty"`
	BytesReadOut int64  `json:"bytesReadOut,omitempty"`
	// Unix timestamp when this entity was created.
	CreatedAt      int64       `json:"createdAt,omitempty"`
	Id             int64       `json:"id,omitempty"`
	NDetectors     int64       `json:"nDetectors,omitempty"`
	NEpns          int64       `json:"nEpns,omitempty"`
	NFlps          int64       `json:"nFlps,omitempty"`
	NSubtimeframes int64       `json:"nSubtimeframes,omitempty"`
	RunNumber      int64       `json:"runNumber,omitempty"`
	RunQuality     *RunQuality `json:"runQuality,omitempty"`
	RunType        *RunType    `json:"runType,omitempty"`
	TimeO2End      int64       `json:"timeO2End,omitempty"`
	TimeO2Start    int64       `json:"timeO2Start,omitempty"`
	TimeTrgEnd     int64       `json:"timeTrgEnd,omitempty"`
	TimeTrgStart   int64       `json:"timeTrgStart,omitempty"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

Describes an intervention or an event that happened.

type RunApiService

type RunApiService service

func (*RunApiService) CreateRun

func (a *RunApiService) CreateRun(ctx context.Context, body Run) (RunResponse, *http.Response, error)

RunApiService Creates a run

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return RunResponse

func (*RunApiService) EndRun

func (a *RunApiService) EndRun(ctx context.Context, body Run, runId int64) (RunResponse, *http.Response, error)

RunApiService Updates certain fields of a run

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body
* @param runId The id of the run to retrieve

@return RunResponse

func (*RunApiService) GetRunById

func (a *RunApiService) GetRunById(ctx context.Context, runId int64) (RunResponse, *http.Response, error)

RunApiService Gets a run by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param runId The id of the run to retrieve

@return RunResponse

func (*RunApiService) ListRuns

RunApiService List all runs

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArrayOfRunsResponse

type RunOrigin

type RunOrigin string

RunOrigin : Type of creator.

const (
	PROCESS_RunOrigin RunOrigin = "process"
)

List of RunOrigin

type RunQuality

type RunQuality string

RunQuality : Specifies the type of run.

const (
	GOOD_RunQuality    RunQuality = "good"
	BAD_RunQuality     RunQuality = "bad"
	UNKNOWN_RunQuality RunQuality = "unknown"
)

List of RunQuality

type RunResponse

type RunResponse struct {
	Data *Run `json:"data"`
}

Response containing a single run.

type RunSortOptions

type RunSortOptions struct {
	Id *SortOrder `json:"id,omitempty"`
}

Specifies the sorting requirements of a run request.

type RunType

type RunType string

RunType : Specifies the type of run.

const (
	PHYSICS_RunType   RunType = "physics"
	COSMICS_RunType   RunType = "cosmics"
	TECHNICAL_RunType RunType = "technical"
)

List of RunType

type SortOrder

type SortOrder string

SortOrder : Specifies the sorting direction of a sorting option.

const (
	ASC_SortOrder  SortOrder = "asc"
	DESC_SortOrder SortOrder = "desc"
)

List of SortOrder

type Subsystem

type Subsystem struct {
	// Unix timestamp when this entity was created.
	CreatedAt int64 `json:"createdAt,omitempty"`
	Id        int64 `json:"id"`
	// The label value of the subsystem.
	Name string `json:"name"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

A label attached to something for the purpose of identification.

type SubsystemApiService

type SubsystemApiService service

func (*SubsystemApiService) CreateSubsystem

SubsystemApiService Adds a new subsystem

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return SubsystemResponse

func (*SubsystemApiService) DeleteSubsystem

func (a *SubsystemApiService) DeleteSubsystem(ctx context.Context, subsystemId int64) (SubsystemResponse, *http.Response, error)

SubsystemApiService Deletes a subsystem by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param subsystemId The id of the subsystem to retrieve

@return SubsystemResponse

func (*SubsystemApiService) GetSubsystem

func (a *SubsystemApiService) GetSubsystem(ctx context.Context, subsystemId int64) (SubsystemResponse, *http.Response, error)

SubsystemApiService Get a subsystem by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param subsystemId The id of the subsystem to retrieve

@return SubsystemResponse

func (*SubsystemApiService) ListSubsystems

SubsystemApiService List all subsystems

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArrayOfSubsystemsResponse

type SubsystemResponse

type SubsystemResponse struct {
	Data *Subsystem `json:"data"`
}

Response containing a single subsystem.

type Tag

type Tag struct {
	// Unix timestamp when this entity was created.
	CreatedAt int64 `json:"createdAt,omitempty"`
	Id        int64 `json:"id"`
	// The label value of the tag.
	Text string `json:"text"`
	// Unix timestamp when this entity was last updated.
	UpdatedAt int64 `json:"updatedAt,omitempty"`
}

A label attached to something for the purpose of identification.

type TagApiService

type TagApiService service

func (*TagApiService) CreateTag

func (a *TagApiService) CreateTag(ctx context.Context, body CreateTag) (TagResponse, *http.Response, error)

TagApiService Adds a new tag

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param body

@return TagResponse

func (*TagApiService) DeleteTagById

func (a *TagApiService) DeleteTagById(ctx context.Context, tagId int64) (TagResponse, *http.Response, error)

TagApiService Deletes a tag by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param tagId The id of the tag to retrieve

@return TagResponse

func (*TagApiService) GetLogsByTagId

func (a *TagApiService) GetLogsByTagId(ctx context.Context, tagId int64) (ArrayOfLogsResponse, *http.Response, error)

TagApiService Gets all logs with this tag id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param tagId The id of the tag to retrieve

@return ArrayOfLogsResponse

func (*TagApiService) GetTagById

func (a *TagApiService) GetTagById(ctx context.Context, tagId int64) (TagResponse, *http.Response, error)

TagApiService Gets a tag by Id

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
* @param tagId The id of the tag to retrieve

@return TagResponse

func (*TagApiService) ListTags

TagApiService List all tags

* @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().

@return ArrayOfTagsResponse

type TagResponse

type TagResponse struct {
	Data *Tag `json:"data"`
}

Response containing a single tag.

type UpdateFlp

type UpdateFlp struct {
	NTimeframes           int64 `json:"nTimeframes,omitempty"`
	BytesProcessed        int64 `json:"bytesProcessed,omitempty"`
	BytesEquipmentReadOut int64 `json:"bytesEquipmentReadOut,omitempty"`
	BytesRecordingReadOut int64 `json:"bytesRecordingReadOut,omitempty"`
	BytesFairMQReadOut    int64 `json:"bytesFairMQReadOut,omitempty"`
}

Describes an update to an flp

type User

type User struct {
	// The unique CERN identifier of this user.
	ExternalId int64 `json:"externalId"`
	// The unique identifier of this entity.
	Id int64 `json:"id"`
	// Name of the user.
	Name string `json:"name"`
}

Describes an intervention or an event that happened.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL