apiDocs

Documentation

Index

• type BadRequestResponse
• type FailureResponse
• type OpenAPIDocs
  • func InitializeOpenAPIReflector() *OpenAPIDocs
  • func (d *OpenAPIDocs) AddCloudNodeOperations()
  • func (d *OpenAPIDocs) AddCompletionOperations()
  • func (d *OpenAPIDocs) AddControlsOperations()
  • func (d *OpenAPIDocs) AddDiagnosisOperations()
  • func (d *OpenAPIDocs) AddDiffAddOperations()
  • func (d *OpenAPIDocs) AddGraphOperations()
  • func (d *OpenAPIDocs) AddIngestersOperations()
  • func (d *OpenAPIDocs) AddIntegrationOperations()
  • func (d *OpenAPIDocs) AddInternalAuthOperations()
  • func (d *OpenAPIDocs) AddLicenseOperations()
  • func (d *OpenAPIDocs) AddLookupOperations()
  • func (d *OpenAPIDocs) AddNonJSONOperation(id, method, path, summary, description string, successStatusCode int, ...)
  • func (d *OpenAPIDocs) AddOperation(id, method, path, summary, description string, successStatusCode int, ...)
  • func (d *OpenAPIDocs) AddRegistryOperations()
  • func (d *OpenAPIDocs) AddReportsOperations()
  • func (d *OpenAPIDocs) AddScansOperations()
  • func (d *OpenAPIDocs) AddSearchOperations()
  • func (d *OpenAPIDocs) AddSettingsOperations()
  • func (d *OpenAPIDocs) AddUserAuthOperations()
  • func (d *OpenAPIDocs) AddUserOperations()
  • func (d *OpenAPIDocs) JSON() ([]byte, error)
  • func (d *OpenAPIDocs) Yaml() ([]byte, error)

Types

type BadRequestResponse

type BadRequestResponse struct {
	Success     bool               `json:"success" example:"false"`
	Message     string             `json:"message"`
	ErrorFields *map[string]string `json:"error_fields"`
	ErrorIndex  *map[string][]int  `json:"error_index"`
}

type FailureResponse

type FailureResponse struct {
	Success bool   `json:"success" example:"false"`
	Message string `json:"message"`
}

type OpenAPIDocs

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

func InitializeOpenAPIReflector

func InitializeOpenAPIReflector() *OpenAPIDocs

func (*OpenAPIDocs) AddCloudNodeOperations

func (d *OpenAPIDocs) AddCloudNodeOperations()

func (*OpenAPIDocs) AddCompletionOperations

func (d *OpenAPIDocs) AddCompletionOperations()

func (*OpenAPIDocs) AddControlsOperations

func (d *OpenAPIDocs) AddControlsOperations()

func (*OpenAPIDocs) AddDiagnosisOperations

func (d *OpenAPIDocs) AddDiagnosisOperations()

func (*OpenAPIDocs) AddDiffAddOperations

func (d *OpenAPIDocs) AddDiffAddOperations()

func (*OpenAPIDocs) AddGraphOperations

func (d *OpenAPIDocs) AddGraphOperations()

func (*OpenAPIDocs) AddIngestersOperations

func (d *OpenAPIDocs) AddIngestersOperations()

func (*OpenAPIDocs) AddIntegrationOperations

func (d *OpenAPIDocs) AddIntegrationOperations()

func (*OpenAPIDocs) AddInternalAuthOperations

func (d *OpenAPIDocs) AddInternalAuthOperations()

func (*OpenAPIDocs) AddLicenseOperations

func (d *OpenAPIDocs) AddLicenseOperations()

func (*OpenAPIDocs) AddLookupOperations

func (d *OpenAPIDocs) AddLookupOperations()

func (*OpenAPIDocs) AddNonJSONOperation

func (d *OpenAPIDocs) AddNonJSONOperation(id, method, path, summary, description string, successStatusCode int, tags []string,
	security []map[string][]string, request interface{}, respContentType string)

func (*OpenAPIDocs) AddOperation

func (d *OpenAPIDocs) AddOperation(id, method, path, summary, description string, successStatusCode int, tags []string,
	security []map[string][]string, request interface{}, response interface{})

func (*OpenAPIDocs) AddRegistryOperations

func (d *OpenAPIDocs) AddRegistryOperations()

func (*OpenAPIDocs) AddReportsOperations

func (d *OpenAPIDocs) AddReportsOperations()

func (*OpenAPIDocs) AddScansOperations

func (d *OpenAPIDocs) AddScansOperations()

func (*OpenAPIDocs) AddSearchOperations

func (d *OpenAPIDocs) AddSearchOperations()

func (*OpenAPIDocs) AddSettingsOperations

func (d *OpenAPIDocs) AddSettingsOperations()

func (*OpenAPIDocs) AddUserAuthOperations

func (d *OpenAPIDocs) AddUserAuthOperations()

func (*OpenAPIDocs) AddUserOperations

func (d *OpenAPIDocs) AddUserOperations()

func (*OpenAPIDocs) JSON

func (d *OpenAPIDocs) JSON() ([]byte, error)

func (*OpenAPIDocs) Yaml

func (d *OpenAPIDocs) Yaml() ([]byte, error)