api

package
v0.0.0-...-6243be3 Latest Latest
Warning

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

 Go to latest Published: Feb 20, 2025 License: Apache-2.0 Imports: 21 Imported by: 0

README

API Directory

This directory contains all API-related files.

Structure

api
├── README.md
├── generated
│   └── alarms.generated.go           # Generated Go code (do not edit manually)
├── openapi.yaml                      # OpenAPI specification
└── tools
    ├── generate.go                   # Code generation script
    └── oapi-codegen.yaml             # Config file for `oapi-codegen`

How to Generate Server Side Code

go generate ./...

How to Generate Client Side Code

Note: This is simply here for convenience and make sure we don't generate any internal endpoint clients

# overlay
overlay: 1.0.0
info:
  title: "Example to indicate how to use the OpenAPI Overlay specification (https://github.com/OAI/Overlay-Specification) and only generate external client-side code"
  version: 1.0.0
actions:
- target: $.paths.*.*[?(@.tags[*] == 'internal')]
  description: Remove internal endpoints (noted by internal tag)
  remove: true

# oapi-codegen-client-config.yaml
# yaml-language-server: $schema=https://raw.githubusercontent.com/oapi-codegen/oapi-codegen/HEAD/configuration-schema.json
package: client
output: client.generated.go

generate:
  client: true
  models: true

output-options:
  overlay:
    path: overlay.yaml

Documentation

Index

Constants

View Source 
const (
	DefaultRetentionPeriod = 1 // Default retention of resolved alarms in days

)

Variables

This section is empty.

Functions

This section is empty.

Types

type AlarmsServer 

type AlarmsServer struct {
	// GlobalCloudID is the global O-Cloud identifier. Create subscription requests are blocked if the global O-Cloud identifier is not set
	GlobalCloudID uuid.UUID
	// AlarmsRepository is the repository for the alarms
	AlarmsRepository repo.AlarmRepositoryInterface
	// Infrastructure clients
	Infrastructure *infrastructure.Infrastructure
	// Wg to allow alarm server level background tasks to finish before graceful exit
	Wg sync.WaitGroup
	// NotificationProvider to handle new events
	NotificationProvider notifier.NotificationProvider
	// Notifier to notify subscribers with new events
	Notifier *notifier.Notifier
	// ServiceConfig config needed to manage ServiceConfig
	ServiceConfig serviceconfig.Config
}

func (*AlarmsServer) AmNotification 

func (a *AlarmsServer) AmNotification(ctx context.Context, request api.AmNotificationRequestObject) (api.AmNotificationResponseObject, error)

AmNotification handles an API request coming from AlertManager with CaaS alerts. This api is used internally. Note: the errors returned can also be view under alertmanager pod logs but also logging here for convenience

func (*AlarmsServer) CreateSubscription 

func (a *AlarmsServer) CreateSubscription(ctx context.Context, request api.CreateSubscriptionRequestObject) (api.CreateSubscriptionResponseObject, error)

CreateSubscription handles an API request to create an Alarm Subscription

func (*AlarmsServer) DeleteSubscription 

func (a *AlarmsServer) DeleteSubscription(ctx context.Context, request api.DeleteSubscriptionRequestObject) (api.DeleteSubscriptionResponseObject, error)

DeleteSubscription handles an API request to delete an Alarm Subscription

func (*AlarmsServer) GetAlarm 

func (a *AlarmsServer) GetAlarm(ctx context.Context, request api.GetAlarmRequestObject) (api.GetAlarmResponseObject, error)

GetAlarm handles an API request to retrieve an Alarm Event Record

func (*AlarmsServer) GetAlarms 

func (a *AlarmsServer) GetAlarms(ctx context.Context, request api.GetAlarmsRequestObject) (api.GetAlarmsResponseObject, error)

GetAlarms handles an API request to fetch Alarm Event Records

func (*AlarmsServer) GetAllVersions 

func (a *AlarmsServer) GetAllVersions(ctx context.Context, request api.GetAllVersionsRequestObject) (api.GetAllVersionsResponseObject, error)

GetAllVersions receives the API request to this endpoint, executes the request, and responds appropriately

func (*AlarmsServer) GetMinorVersions 

func (a *AlarmsServer) GetMinorVersions(ctx context.Context, request api.GetMinorVersionsRequestObject) (api.GetMinorVersionsResponseObject, error)

GetMinorVersions receives the API request to this endpoint, executes the request, and responds appropriately

func (*AlarmsServer) GetServiceConfiguration 

func (a *AlarmsServer) GetServiceConfiguration(ctx context.Context, _ api.GetServiceConfigurationRequestObject) (api.GetServiceConfigurationResponseObject, error)

GetServiceConfiguration handles an API request to fetch the Alarm Service Configuration

func (*AlarmsServer) GetSubscription 

func (a *AlarmsServer) GetSubscription(ctx context.Context, request api.GetSubscriptionRequestObject) (api.GetSubscriptionResponseObject, error)

GetSubscription handles an API request to retrieve an Alarm Subscription

func (*AlarmsServer) GetSubscriptions 

func (a *AlarmsServer) GetSubscriptions(ctx context.Context, request api.GetSubscriptionsRequestObject) (api.GetSubscriptionsResponseObject, error)

GetSubscriptions handles an API request to fetch Alarm Subscriptions

func (*AlarmsServer) HwNotification 

func (a *AlarmsServer) HwNotification(ctx context.Context, request api.HwNotificationRequestObject) (api.HwNotificationResponseObject, error)

func (*AlarmsServer) PatchAlarm 

func (a *AlarmsServer) PatchAlarm(ctx context.Context, request api.PatchAlarmRequestObject) (api.PatchAlarmResponseObject, error)

PatchAlarm handles an API request to patch an Alarm Event Record

func (*AlarmsServer) PatchAlarmServiceConfiguration 

func (a *AlarmsServer) PatchAlarmServiceConfiguration(ctx context.Context, request api.PatchAlarmServiceConfigurationRequestObject) (api.PatchAlarmServiceConfigurationResponseObject, error)

PatchAlarmServiceConfiguration handles an API request to patch the Alarm Service Configuration

func (*AlarmsServer) UpdateAlarmServiceConfiguration 

func (a *AlarmsServer) UpdateAlarmServiceConfiguration(ctx context.Context, request api.UpdateAlarmServiceConfigurationRequestObject) (api.UpdateAlarmServiceConfigurationResponseObject, error)

type AlarmsServerConfig 

type AlarmsServerConfig struct {
	utils.CommonServerConfig
	Address       string
	GlobalCloudID string
}

AlarmsServerConfig defines the configuration attributes for the alarms server

Source Files

View all Source files

Directories

Path Synopsis
Package generated provides primitives to interact with the openapi HTTP API.
 Package generated 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
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.