api

Documentation

Overview

Generated by https://quicktype.io

Index

• type API
• type Action
• type Changelog
• type Param
• type WebService

Types

type API

type API struct {
	WebServices []WebService `json:"webServices"`
}

type Action

type Action struct {
	Key                string      `json:"key"`
	Description        string      `json:"description"`
	Since              string      `json:"since"`
	Internal           bool        `json:"internal"`
	Post               bool        `json:"post"`
	HasResponseExample bool        `json:"hasResponseExample"`
	Changelog          []Changelog `json:"changelog"`
	Params             []Param     `json:"params"`
	DeprecatedSince    string      `json:"deprecatedSince,omitempty"`
	ResponseType       string      `json:"responseType,omitempty"`
}

type Changelog

type Changelog struct {
	Description string `json:"description"`
	Version     string `json:"version"`
}

type Param

type Param struct {
	Key                string   `json:"key"`
	Description        string   `json:"description,omitempty"`
	Required           bool     `json:"required"`
	Internal           bool     `json:"internal"`
	ExampleValue       string   `json:"exampleValue,omitempty"`
	DeprecatedSince    string   `json:"deprecatedSince,omitempty"`
	DefaultValue       string   `json:"defaultValue,omitempty"`
	PossibleValues     []string `json:"possibleValues"`
	DeprecatedKey      string   `json:"deprecatedKey,omitempty"`
	DeprecatedKeySince string   `json:"deprecatedKeySince,omitempty"`
	MaximumValue       int64    `json:"maximumValue,omitempty"`
	Since              string   `json:"since,omitempty"`
	MinimumLength      int64    `json:"minimumLength,omitempty"`
	MaxValuesAllowed   int64    `json:"maxValuesAllowed,omitempty"`
	MaximumLength      int64    `json:"maximumLength,omitempty"`
}

type WebService

type WebService struct {
	Path        string   `json:"path"`
	Description string   `json:"description,omitempty"`
	Actions     []Action `json:"actions"`
	Since       string   `json:"since,omitempty"`
}