Documentation
¶
Index ¶
Constants ¶
View Source
const ( // info extension key INFO_EXTENSION_OWNER = "x-owner" // component extension key COMPONENT_EXTENSION_NAME = "name" // path extension key PATH_EXTENSION_URL = "url" PATH_EXTENSION_ACTION = "action" PATH_EXTENSION_EXAMPLES = "x-examples" )
View Source
const (
DOCS_INDEX = "window.RailsData"
)
Variables ¶
This section is empty.
Functions ¶
Types ¶
type LandingPageData ¶
type ShopifyAPIMeta ¶
type ShopifyAPIMeta struct {
BasePath string `json:"base_path"`
RestResource *ShopifyOpenAPISpec `json:"rest_resource,omitempty"`
SelectableVersions []string `json:"selectable_versions"`
CurrentStableVersion string `json:"current_stable_version"`
LandingPage string `json:"landing_page"`
LandingPageId string `json:"landing_page_id"`
LandingPageData LandingPageData `json:"landing_page_data"`
}
type ShopifyDocsMeta ¶
type ShopifyDocsMeta struct {
Features []string `json:"features"`
Env string `json:"env"`
API *ShopifyAPIMeta `json:"api"`
}
type ShopifyOpenAPISpec ¶
type ShopifyOpenAPISpec struct {
Info openapi3.Info `json:"info"`
XShopifyMeta XShopifyMeta `json:"x-shopify-meta"`
OpenAPI string `json:"openapi" yaml:"openapi"` // Required
Components []*ShopifyOpenapiComponent `json:"components,omitempty" yaml:"components,omitempty"`
Paths []*openapi3.Operation `json:"paths" yaml:"paths"` // Required
}
type ShopifyOpenapiComponent ¶
type ShopifyOpenapiComponent struct {
Name string `json:"name"`
Properties []*openapi3.Schema `json:"properties,omitempty"`
Required []string `json:"required,omitempty" yaml:"required,omitempty"`
Type string `json:"type,omitempty" yaml:"type,omitempty"`
Title string `json:"title,omitempty" yaml:"title,omitempty"`
}
type ShopifyRestSideNav ¶
type ShopifyRestSideNav struct {
}
type SpiderHandlerFunc ¶
func ExtraShopifyOpenApiMeta ¶
func ExtraShopifyOpenApiMeta(version string) SpiderHandlerFunc[ShopifyAPIMeta]
type XShopifyMeta ¶
Click to show internal directories.
Click to hide internal directories.