Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Binding ¶
type Binding struct { Request string `json:"request,omitempty"` Response string `json:"response,omitempty"` }
Binding is a relationship between request and/or response
type Body ¶
type Components ¶
type Node ¶
type Node struct { Description string `json:"description,omitempty"` Availability string `json:"x-databricks-availability,omitempty"` Ref string `json:"$ref,omitempty"` }
type Operation ¶
type Operation struct { Node Wait *Wait `json:"x-databricks-wait,omitempty"` Pagination *Pagination `json:"x-databricks-pagination,omitempty"` Shortcut bool `json:"x-databricks-shortcut,omitempty"` Crud string `json:"x-databricks-crud,omitempty"` Summary string `json:"summary,omitempty"` OperationId string `json:"operationId"` Tags []string `json:"tags"` Parameters []Parameter `json:"parameters,omitempty"` Responses map[string]*Body `json:"responses"` RequestBody *Body `json:"requestBody,omitempty"` }
Operation is the equivalent of method
func (*Operation) Name ¶
Name is picking the last element of <ServiceName>.<method> string, that is coming in as part of Databricks OpenAPI spec.
func (*Operation) SuccessResponseSchema ¶
func (o *Operation) SuccessResponseSchema(c *Components) *Schema
type Pagination ¶
type Pagination struct { Offset string `json:"offset,omitempty"` Limit string `json:"limit,omitempty"` Results string `json:"results,omitempty"` Increment int `json:"increment,omitempty"` Inline bool `json:"inline,omitempty"` Token *Binding `json:"token,omitempty"` }
Pagination is the Databricks OpenAPI Extension for retrieving lists of entities through multiple API calls
type Path ¶
type Schema ¶
type Schema struct { Node IsIdentifier bool `json:"x-databricks-id,omitempty"` IsName bool `json:"x-databricks-name,omitempty"` IsComputed bool `json:"x-databricks-computed,omitempty"` IsAny bool `json:"x-databricks-any,omitempty"` Type string `json:"type,omitempty"` Enum []string `json:"enum,omitempty"` AliasEnum []string `json:"x-databricks-alias-enum,omitempty"` EnumDescriptions map[string]string `json:"x-databricks-enum-descriptions,omitempty"` Default any `json:"default,omitempty"` Example any `json:"example,omitempty"` Format string `json:"format,omitempty"` Required []string `json:"required,omitempty"` Properties map[string]*Schema `json:"properties,omitempty"` ArrayValue *Schema `json:"items,omitempty"` MapValue *Schema `json:"additionalProperties,omitempty"` }
func (*Schema) IsDefinable ¶
IsDefinable states that type could be translated into a valid top-level type in Go, Python, Java, Scala, and JavaScript
type Specification ¶
type Specification struct { Node Paths map[string]Path `json:"paths"` Components *Components `json:"components"` Tags []Tag `json:"tags"` }
func NewFromReader ¶
func NewFromReader(r io.Reader) (*Specification, error)
type Wait ¶
type Wait struct { Poll string `json:"poll"` Bind string `json:"bind"` BindResponse string `json:"bindResponse,omitempty"` Binding map[string]Binding `json:"binding,omitempty"` Field []string `json:"field"` Message []string `json:"message"` Success []string `json:"success"` Failure []string `json:"failure"` Timeout int `json:"timeout,omitempty"` }
Wait is the Databricks OpenAPI Extension for long-running result polling
Directories ¶
Path | Synopsis |
---|---|
Package holds higher-level abstractions on top of OpenAPI that are used to generate code via text/template for Databricks SDK in different languages.
|
Package holds higher-level abstractions on top of OpenAPI that are used to generate code via text/template for Databricks SDK in different languages. |
Usage: openapi-codegen
|
Usage: openapi-codegen |
Click to show internal directories.
Click to hide internal directories.