options

Documentation

Index

• type ActionSetup
• type DSAOptionsService
  • func New(c common.Client) *DSAOptionsService
  • func (svc *DSAOptionsService) GetOfferings(ctx context.Context, projectID string) (res OfferingsResponse, err error)
• type Offer
• type OfferingsResponse
• type Plan
• type Schema

Types

type ActionSetup

type ActionSetup struct {
	Parameters map[string]interface{} `json:"parameters"`
}

ActionSetup is the setup of action such as create or update

type DSAOptionsService

type DSAOptionsService common.Service

DSAOptionsService is the service that retrieves the DSA options

func New

func New(c common.Client) *DSAOptionsService

New returns a new handler for the service

func (*DSAOptionsService) GetOfferings

func (svc *DSAOptionsService) GetOfferings(ctx context.Context, projectID string) (res OfferingsResponse, err error)

GetVersions returns all available DSA offerings See also https://api.stackit.schwarz/data-services/openapi.v1.html#tag/Offerings

type Offer

type Offer struct {
	Name             string `json:"name"`
	Version          string `json:"version"`
	Latest           bool   `json:"latest"`
	DocumentationURL string `json:"documentationUrl"`
	Description      string `json:"description"`
	QuotaCount       int    `json:"quotaCount"`
	ImageURL         string `json:"imageUrl"`
	Schema           Schema `json:"schema"`
	Plans            []Plan `json:"plans"`
}

Offering represents a single DSA offer

type OfferingsResponse

type OfferingsResponse struct {
	Offerings []Offer `json:"offerings,omitempty"`
}

OfferingsResponse is the APIs response for available offerings

type Plan

type Plan struct {
	ID          string `json:"id"`
	Name        string `json:"name"`
	Description string `json:"description"`
	Free        bool   `json:"free"`
}

Plan is a single plan an offer provides

type Schema

type Schema struct {
	Create ActionSetup `json:"create"`
	Update ActionSetup `json:"update"`
}

Schema is an ofer schema struct