sdk

package module

Go to main page

Versions in this module

v0

v0.4.0

Aug 28, 2026

Changes in this version

+ const ManagedDocVersionToolsEnabledToolExecuteRequest

+ const ManagedDocVersionToolsEnabledToolGetMiniOpenapiSpec

+ const ManagedDocVersionToolsMethodDelete

+ const ManagedDocVersionToolsMethodGet

+ const ManagedDocVersionToolsMethodHead

+ const ManagedDocVersionToolsMethodOptions

+ const ManagedDocVersionToolsMethodPatch

+ const ManagedDocVersionToolsMethodPost

+ const ManagedDocVersionToolsMethodPut

+ const ManagedDocVersionToolsMethodTrace

+ type ManagedDocVersionTool = shared.ManagedDocVersionTool

+ type ManagedDocVersionToolsEnabledTool = shared.ManagedDocVersionToolsEnabledTool

+ type ManagedDocVersionToolsMethod = shared.ManagedDocVersionToolsMethod

+ type Namespace = shared.Namespace

+ type Nanoid = shared.Nanoid

+ type SchemaAccessGroupDeleteParams struct

+ AccessGroup AccessGroupParam

+ func (r SchemaAccessGroupDeleteParams) MarshalJSON() (data []byte, err error)

+ type SchemaAccessGroupNewParams struct

+ AccessGroup AccessGroupParam

+ func (r SchemaAccessGroupNewParams) MarshalJSON() (data []byte, err error)

type SchemaAccessGroupService

+ func (r *SchemaAccessGroupService) Delete(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *SchemaAccessGroupService) New(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ type SchemaVersionNewParams struct

+ Document param.Field[string]

+ Version param.Field[string]

+ func (r SchemaVersionNewParams) MarshalJSON() (data []byte, err error)

type SchemaVersionService

+ func (r *SchemaVersionService) Delete(ctx context.Context, namespace string, slug string, semver string, ...) (res *map[string]interface{}, err error)

+ func (r *SchemaVersionService) Get(ctx context.Context, namespace string, slug string, semver string, ...) (res *string, err error)

+ func (r *SchemaVersionService) New(ctx context.Context, namespace string, slug string, ...) (res *shared.UID, err error)

+ type Timestamp = shared.Timestamp

+ type UID = shared.UID

+ type Value400 = shared.Value400

+ type Value401 = shared.Value401

+ type Value403 = shared.Value403

+ type Value404 = shared.Value404

+ type Value422 = shared.Value422

+ type Value500 = shared.Value500

v0.3.4

Aug 7, 2026

v0.3.3

Aug 7, 2026

v0.3.2

Jul 28, 2026

v0.3.1

Jul 27, 2026

Changes in this version

type ManagedDocVersion

+ JsonSha string

type RegistryListAPIDocumentVersionMetadataResponse

+ JsonSha string

type RegistryNewAPIDocumentResponse

+ JsonSha string

type RegistryNewAPIDocumentVersionResponse

+ JsonSha string

type RegistryUpdateAPIDocumentVersionResponse

+ JsonSha string

v0.3.0

Jul 27, 2026

v0.2.0

Jul 20, 2026

Changes in this version

+ func Bool(value bool) param.Field[bool]

+ func DefaultClientOptions() []option.RequestOption

+ func F[T any](value T) param.Field[T]

+ func FileParam(reader io.Reader, filename string, contentType string) param.Field[io.Reader]

+ func Float(value float64) param.Field[float64]

+ func Int(value int64) param.Field[int64]

+ func Null[T any]() param.Field[T]

+ func Raw[T any](value any) param.Field[T]

+ func String(value string) param.Field[string]

+ type APIDocument struct

+ Description string

+ IsPrivate bool

+ JSON apiDocumentJSON

+ Namespace string

+ Slug string

+ Tags interface{}

+ Title string

+ UID string

+ Version string

+ Versions []ManagedDocVersion

+ func (r *APIDocument) UnmarshalJSON(data []byte) (err error)

+ type AccessGroupParam struct

+ AccessGroupSlug param.Field[string]

+ func (r AccessGroupParam) MarshalJSON() (data []byte, err error)

+ type AuthenticationExchangePersonalTokenParams struct

+ PersonalToken param.Field[string]

+ func (r AuthenticationExchangePersonalTokenParams) MarshalJSON() (data []byte, err error)

+ type AuthenticationExchangePersonalTokenResponse struct

+ AccessToken string

+ JSON authenticationExchangePersonalTokenResponseJSON

+ func (r *AuthenticationExchangePersonalTokenResponse) UnmarshalJSON(data []byte) (err error)

+ type AuthenticationListCurrentUserResponse struct

+ ActiveTeamID string

+ CreatedAt int64

+ Email string

+ HasGithub bool

+ JSON authenticationListCurrentUserResponseJSON

+ Teams []AuthenticationListCurrentUserResponseTeam

+ Theme string

+ UID string

+ UpdatedAt int64

+ func (r *AuthenticationListCurrentUserResponse) UnmarshalJSON(data []byte) (err error)

+ type AuthenticationListCurrentUserResponseTeam struct

+ ImageURI string

+ JSON authenticationListCurrentUserResponseTeamJSON

+ Name string

+ UID string

+ func (r *AuthenticationListCurrentUserResponseTeam) UnmarshalJSON(data []byte) (err error)

+ type AuthenticationService struct

+ Options []option.RequestOption

+ func NewAuthenticationService(opts ...option.RequestOption) (r *AuthenticationService)

+ func (r *AuthenticationService) ExchangePersonalToken(ctx context.Context, body AuthenticationExchangePersonalTokenParams, ...) (res *AuthenticationExchangePersonalTokenResponse, err error)

+ func (r *AuthenticationService) ListCurrentUser(ctx context.Context, opts ...option.RequestOption) (res *AuthenticationListCurrentUserResponse, err error)

+ type Client struct

+ Authentication *AuthenticationService

+ LoginPortals *LoginPortalService

+ Namespaces *NamespaceService

+ Options []option.RequestOption

+ Registry *RegistryService

+ Rules *RuleService

+ ScalarDocs *ScalarDocService

+ Schemas *SchemaService

+ Teams *TeamService

+ Themes *ThemeService

+ func NewClient(opts ...option.RequestOption) (r *Client)

+ func (r *Client) Delete(ctx context.Context, path string, params interface{}, res interface{}, ...) error

+ func (r *Client) Execute(ctx context.Context, method string, path string, params interface{}, ...) error

+ func (r *Client) Get(ctx context.Context, path string, params interface{}, res interface{}, ...) error

+ func (r *Client) Patch(ctx context.Context, path string, params interface{}, res interface{}, ...) error

+ func (r *Client) Post(ctx context.Context, path string, params interface{}, res interface{}, ...) error

+ func (r *Client) Put(ctx context.Context, path string, params interface{}, res interface{}, ...) error

+ type Error = apierror.Error

+ type GithubProject struct

+ AccessGroups interface{}

+ ActiveDeployment GithubProjectActiveDeployment

+ ActiveThemeID string

+ AgentEnabled bool

+ CreatedAt int64

+ IsPrivate bool

+ JSON githubProjectJSON

+ LastPublished int64

+ LastPublishedUID string

+ LoginPortalUID string

+ Name string

+ PublishMessage string

+ PublishStatus string

+ Repository GithubProjectRepository

+ Slug string

+ TypesenseID float64

+ UID string

+ UpdatedAt int64

+ func (r *GithubProject) UnmarshalJSON(data []byte) (err error)

+ type GithubProjectActiveDeployment struct

+ Domain string

+ JSON githubProjectActiveDeploymentJSON

+ PublishedAt int64

+ UID string

+ func (r *GithubProjectActiveDeployment) UnmarshalJSON(data []byte) (err error)

+ type GithubProjectActiveDeploymentParam struct

+ Domain param.Field[string]

+ PublishedAt param.Field[int64]

+ UID param.Field[string]

+ func (r GithubProjectActiveDeploymentParam) MarshalJSON() (data []byte, err error)

+ type GithubProjectRepository struct

+ Branch string

+ ConfigPath string

+ Expired bool

+ ID float64

+ JSON githubProjectRepositoryJSON

+ LinkedBy string

+ Name string

+ PrComments bool

+ PublishOnMerge bool

+ PublishPreviews bool

+ func (r *GithubProjectRepository) UnmarshalJSON(data []byte) (err error)

+ type LoginPortal struct

+ JSON loginPortalJSON

+ Slug string

+ Title string

+ UID string

+ func (r *LoginPortal) UnmarshalJSON(data []byte) (err error)

+ type LoginPortalEmail struct

+ ButtonBackground string

+ ButtonColor string

+ ButtonText string

+ CardBackground string

+ CardColor string

+ JSON loginPortalEmailJSON

+ Logo string

+ LogoSize string

+ MainBackground string

+ MainColor string

+ Message string

+ Title string

+ func (r *LoginPortalEmail) UnmarshalJSON(data []byte) (err error)

+ type LoginPortalEmailParam struct

+ ButtonBackground param.Field[string]

+ ButtonColor param.Field[string]

+ ButtonText param.Field[string]

+ CardBackground param.Field[string]

+ CardColor param.Field[string]

+ Logo param.Field[string]

+ LogoSize param.Field[string]

+ MainBackground param.Field[string]

+ MainColor param.Field[string]

+ Message param.Field[string]

+ Title param.Field[string]

+ func (r LoginPortalEmailParam) MarshalJSON() (data []byte, err error)

+ type LoginPortalGetResponse struct

+ Email LoginPortalEmail

+ JSON loginPortalGetResponseJSON

+ Page LoginPortalPage

+ Slug string

+ Title string

+ UID string

+ func (r *LoginPortalGetResponse) UnmarshalJSON(data []byte) (err error)

+ type LoginPortalNewParams struct

+ Email param.Field[LoginPortalEmailParam]

+ Page param.Field[LoginPortalPageParam]

+ Slug param.Field[string]

+ Title param.Field[string]

+ func (r LoginPortalNewParams) MarshalJSON() (data []byte, err error)

+ type LoginPortalNewResponse struct

+ JSON loginPortalNewResponseJSON

+ UID string

+ func (r *LoginPortalNewResponse) UnmarshalJSON(data []byte) (err error)

+ type LoginPortalPage struct

+ CompanyName string

+ Description string

+ Favicon string

+ FormDescription string

+ FormImage string

+ FormTitle string

+ Head string

+ JSON loginPortalPageJSON

+ Logo string

+ LogoURL string

+ PrivacyLink string

+ Script string

+ TermsLink string

+ Theme string

+ Title string

+ func (r *LoginPortalPage) UnmarshalJSON(data []byte) (err error)

+ type LoginPortalPageParam struct

+ CompanyName param.Field[string]

+ Description param.Field[string]

+ Favicon param.Field[string]

+ FormDescription param.Field[string]

+ FormImage param.Field[string]

+ FormTitle param.Field[string]

+ Head param.Field[string]

+ Logo param.Field[string]

+ LogoURL param.Field[string]

+ PrivacyLink param.Field[string]

+ Script param.Field[string]

+ TermsLink param.Field[string]

+ Theme param.Field[string]

+ Title param.Field[string]

+ func (r LoginPortalPageParam) MarshalJSON() (data []byte, err error)

+ type LoginPortalService struct

+ Options []option.RequestOption

+ func NewLoginPortalService(opts ...option.RequestOption) (r *LoginPortalService)

+ func (r *LoginPortalService) Delete(ctx context.Context, slug string, opts ...option.RequestOption) (res *map[string]interface{}, err error)

+ func (r *LoginPortalService) Get(ctx context.Context, slug string, opts ...option.RequestOption) (res *LoginPortalGetResponse, err error)

+ func (r *LoginPortalService) List(ctx context.Context, opts ...option.RequestOption) (res *[]LoginPortal, err error)

+ func (r *LoginPortalService) New(ctx context.Context, body LoginPortalNewParams, opts ...option.RequestOption) (res *LoginPortalNewResponse, err error)

+ func (r *LoginPortalService) Update(ctx context.Context, slug string, body LoginPortalUpdateParams, ...) (res *map[string]interface{}, err error)

+ type LoginPortalUpdateParams struct

+ Title param.Field[string]

+ func (r LoginPortalUpdateParams) MarshalJSON() (data []byte, err error)

+ type ManagedDocVersion struct

+ CreatedAt float64

+ EmbedStatus ManagedDocVersionEmbedStatus

+ JSON managedDocVersionJSON

+ JSONSha string

+ Tags []string

+ Tools []RegistryListAPIDocumentVersionMetadataResponseTool

+ UID string

+ Upgraded bool

+ Version string

+ VersionSha string

+ YamlSha string

+ func (r *ManagedDocVersion) UnmarshalJSON(data []byte) (err error)

+ type ManagedDocVersionEmbedStatus string

+ const ManagedDocVersionEmbedStatusComplete

+ const ManagedDocVersionEmbedStatusFailed

+ func (r ManagedDocVersionEmbedStatus) IsKnown() bool

+ type NamespaceService struct

+ Options []option.RequestOption

+ func NewNamespaceService(opts ...option.RequestOption) (r *NamespaceService)

+ func (r *NamespaceService) List(ctx context.Context, opts ...option.RequestOption) (res *[]string, err error)

+ type RegistryDeleteAPIDocumentAccessGroupParams struct

+ AccessGroup AccessGroupParam

+ func (r RegistryDeleteAPIDocumentAccessGroupParams) MarshalJSON() (data []byte, err error)

+ type RegistryListAPIDocumentVersionMetadataResponse struct

+ CreatedAt float64

+ EmbedStatus RegistryListAPIDocumentVersionMetadataResponseEmbedStatus

+ JSON registryListAPIDocumentVersionMetadataResponseJSON

+ JSONSha string

+ Tags []string

+ Tools []RegistryListAPIDocumentVersionMetadataResponseTool

+ UID string

+ Upgraded bool

+ Version string

+ VersionSha string

+ YamlSha string

+ func (r *RegistryListAPIDocumentVersionMetadataResponse) UnmarshalJSON(data []byte) (err error)

+ type RegistryListAPIDocumentVersionMetadataResponseEmbedStatus string

+ const RegistryListAPIDocumentVersionMetadataResponseEmbedStatusComplete

+ const RegistryListAPIDocumentVersionMetadataResponseEmbedStatusFailed

+ func (r RegistryListAPIDocumentVersionMetadataResponseEmbedStatus) IsKnown() bool

+ type RegistryListAPIDocumentVersionMetadataResponseTool struct

+ EnabledTools []RegistryListAPIDocumentVersionMetadataResponseToolsEnabledTool

+ JSON registryListAPIDocumentVersionMetadataResponseToolJSON

+ Method RegistryListAPIDocumentVersionMetadataResponseToolsMethod

+ Path string

+ func (r *RegistryListAPIDocumentVersionMetadataResponseTool) UnmarshalJSON(data []byte) (err error)

+ type RegistryListAPIDocumentVersionMetadataResponseToolsEnabledTool string

+ const RegistryListAPIDocumentVersionMetadataResponseToolsEnabledToolExecuteRequest

+ const RegistryListAPIDocumentVersionMetadataResponseToolsEnabledToolGetMiniOpenapiSpec

+ func (r RegistryListAPIDocumentVersionMetadataResponseToolsEnabledTool) IsKnown() bool

+ type RegistryListAPIDocumentVersionMetadataResponseToolsMethod string

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodDelete

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodGet

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodHead

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodOptions

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodPatch

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodPost

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodPut

+ const RegistryListAPIDocumentVersionMetadataResponseToolsMethodTrace

+ func (r RegistryListAPIDocumentVersionMetadataResponseToolsMethod) IsKnown() bool

+ type RegistryNewAPIDocumentAccessGroupParams struct

+ AccessGroup AccessGroupParam

+ func (r RegistryNewAPIDocumentAccessGroupParams) MarshalJSON() (data []byte, err error)

+ type RegistryNewAPIDocumentParams struct

+ Description param.Field[string]

+ Document param.Field[string]

+ IsPrivate param.Field[bool]

+ Ruleset param.Field[string]

+ Slug param.Field[string]

+ Title param.Field[string]

+ Version param.Field[string]

+ func (r RegistryNewAPIDocumentParams) MarshalJSON() (data []byte, err error)

+ type RegistryNewAPIDocumentResponse struct

+ JSON registryNewAPIDocumentResponseJSON

+ JSONSha string

+ Title string

+ UID string

+ VersionSha string

+ VersionUID string

+ YamlSha string

+ func (r *RegistryNewAPIDocumentResponse) UnmarshalJSON(data []byte) (err error)

+ type RegistryNewAPIDocumentVersionParams struct

+ Document param.Field[string]

+ Force param.Field[bool]

+ LastKnownVersionSha param.Field[string]

+ Version param.Field[string]

+ func (r RegistryNewAPIDocumentVersionParams) MarshalJSON() (data []byte, err error)

+ type RegistryNewAPIDocumentVersionResponse struct

+ CreatedAt float64

+ EmbedStatus RegistryNewAPIDocumentVersionResponseEmbedStatus

+ JSON registryNewAPIDocumentVersionResponseJSON

+ JSONSha string

+ Tags []string

+ Tools []RegistryListAPIDocumentVersionMetadataResponseTool

+ UID string

+ Upgraded bool

+ Version string

+ VersionSha string

+ YamlSha string

+ func (r *RegistryNewAPIDocumentVersionResponse) UnmarshalJSON(data []byte) (err error)

+ type RegistryNewAPIDocumentVersionResponseEmbedStatus string

+ const RegistryNewAPIDocumentVersionResponseEmbedStatusComplete

+ const RegistryNewAPIDocumentVersionResponseEmbedStatusFailed

+ func (r RegistryNewAPIDocumentVersionResponseEmbedStatus) IsKnown() bool

+ type RegistryService struct

+ Options []option.RequestOption

+ func NewRegistryService(opts ...option.RequestOption) (r *RegistryService)

+ func (r *RegistryService) DeleteAPIDocument(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RegistryService) DeleteAPIDocumentAccessGroup(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RegistryService) DeleteAPIDocumentVersion(ctx context.Context, namespace string, slug string, semver string, ...) (res *map[string]interface{}, err error)

+ func (r *RegistryService) GetAPIDocumentVersion(ctx context.Context, namespace string, slug string, semver string, ...) (res *string, err error)

+ func (r *RegistryService) ListAPIDocumentVersionMetadata(ctx context.Context, namespace string, slug string, semver string, ...) (res *RegistryListAPIDocumentVersionMetadataResponse, err error)

+ func (r *RegistryService) ListAPIDocuments(ctx context.Context, namespace string, opts ...option.RequestOption) (res *[]APIDocument, err error)

+ func (r *RegistryService) ListAllAPIDocuments(ctx context.Context, opts ...option.RequestOption) (res *[]APIDocument, err error)

+ func (r *RegistryService) NewAPIDocument(ctx context.Context, namespace string, body RegistryNewAPIDocumentParams, ...) (res *RegistryNewAPIDocumentResponse, err error)

+ func (r *RegistryService) NewAPIDocumentAccessGroup(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RegistryService) NewAPIDocumentVersion(ctx context.Context, namespace string, slug string, ...) (res *RegistryNewAPIDocumentVersionResponse, err error)

+ func (r *RegistryService) UpdateAPIDocument(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RegistryService) UpdateAPIDocumentVersion(ctx context.Context, namespace string, slug string, semver string, ...) (res *RegistryUpdateAPIDocumentVersionResponse, err error)

+ type RegistryUpdateAPIDocumentParams struct

+ Description param.Field[string]

+ IsPrivate param.Field[bool]

+ Ruleset param.Field[string]

+ Title param.Field[string]

+ func (r RegistryUpdateAPIDocumentParams) MarshalJSON() (data []byte, err error)

+ type RegistryUpdateAPIDocumentVersionParams struct

+ Document param.Field[string]

+ LastKnownVersionSha param.Field[string]

+ func (r RegistryUpdateAPIDocumentVersionParams) MarshalJSON() (data []byte, err error)

+ type RegistryUpdateAPIDocumentVersionResponse struct

+ JSON registryUpdateAPIDocumentVersionResponseJSON

+ JSONSha string

+ VersionSha string

+ YamlSha string

+ func (r *RegistryUpdateAPIDocumentVersionResponse) UnmarshalJSON(data []byte) (err error)

+ type Rule struct

+ Description string

+ IsPrivate bool

+ JSON ruleJSON

+ Namespace string

+ Slug string

+ Title string

+ UID string

+ func (r *Rule) UnmarshalJSON(data []byte) (err error)

+ type RuleDeleteRulesetAccessGroupParams struct

+ AccessGroup AccessGroupParam

+ func (r RuleDeleteRulesetAccessGroupParams) MarshalJSON() (data []byte, err error)

+ type RuleNewRulesetAccessGroupParams struct

+ AccessGroup AccessGroupParam

+ func (r RuleNewRulesetAccessGroupParams) MarshalJSON() (data []byte, err error)

+ type RuleNewRulesetParams struct

+ Description param.Field[string]

+ Document param.Field[string]

+ IsPrivate param.Field[bool]

+ Slug param.Field[string]

+ Title param.Field[string]

+ func (r RuleNewRulesetParams) MarshalJSON() (data []byte, err error)

+ type RuleNewRulesetResponse struct

+ JSON ruleNewRulesetResponseJSON

+ UID string

+ func (r *RuleNewRulesetResponse) UnmarshalJSON(data []byte) (err error)

+ type RuleService struct

+ Options []option.RequestOption

+ func NewRuleService(opts ...option.RequestOption) (r *RuleService)

+ func (r *RuleService) DeleteRuleset(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RuleService) DeleteRulesetAccessGroup(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RuleService) GetRulesetDocument(ctx context.Context, namespace string, slug string, ...) (res *string, err error)

+ func (r *RuleService) ListRulesets(ctx context.Context, namespace string, opts ...option.RequestOption) (res *[]Rule, err error)

+ func (r *RuleService) NewRuleset(ctx context.Context, namespace string, body RuleNewRulesetParams, ...) (res *RuleNewRulesetResponse, err error)

+ func (r *RuleService) NewRulesetAccessGroup(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *RuleService) UpdateRuleset(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ type RuleUpdateRulesetParams struct

+ Description param.Field[string]

+ IsPrivate param.Field[bool]

+ Namespace param.Field[string]

+ Slug param.Field[string]

+ Title param.Field[string]

+ func (r RuleUpdateRulesetParams) MarshalJSON() (data []byte, err error)

+ type ScalarDocNewGuideParams struct

+ AllowedDomains param.Field[[]string]

+ AllowedUsers param.Field[[]string]

+ IsPrivate param.Field[bool]

+ Name param.Field[string]

+ Slug param.Field[string]

+ func (r ScalarDocNewGuideParams) MarshalJSON() (data []byte, err error)

+ type ScalarDocNewGuideResponse struct

+ JSON scalarDocNewGuideResponseJSON

+ Slug string

+ UID string

+ func (r *ScalarDocNewGuideResponse) UnmarshalJSON(data []byte) (err error)

+ type ScalarDocPublishGuideResponse struct

+ JSON scalarDocPublishGuideResponseJSON

+ PublishUID string

+ func (r *ScalarDocPublishGuideResponse) UnmarshalJSON(data []byte) (err error)

+ type ScalarDocService struct

+ Options []option.RequestOption

+ func NewScalarDocService(opts ...option.RequestOption) (r *ScalarDocService)

+ func (r *ScalarDocService) ListGuides(ctx context.Context, opts ...option.RequestOption) (res *[]GithubProject, err error)

+ func (r *ScalarDocService) NewGuide(ctx context.Context, body ScalarDocNewGuideParams, ...) (res *ScalarDocNewGuideResponse, err error)

+ func (r *ScalarDocService) PublishGuide(ctx context.Context, slug string, opts ...option.RequestOption) (res *ScalarDocPublishGuideResponse, err error)

+ type Schema struct

+ Description string

+ IsPrivate bool

+ JSON schemaJSON

+ Namespace string

+ Slug string

+ Title string

+ UID string

+ Versions []SchemaVersion

+ func (r *Schema) UnmarshalJSON(data []byte) (err error)

+ type SchemaAccessGroupDeleteSchemaParams struct

+ AccessGroup AccessGroupParam

+ func (r SchemaAccessGroupDeleteSchemaParams) MarshalJSON() (data []byte, err error)

+ type SchemaAccessGroupNewSchemaParams struct

+ AccessGroup AccessGroupParam

+ func (r SchemaAccessGroupNewSchemaParams) MarshalJSON() (data []byte, err error)

+ type SchemaAccessGroupService struct

+ Options []option.RequestOption

+ func NewSchemaAccessGroupService(opts ...option.RequestOption) (r *SchemaAccessGroupService)

+ func (r *SchemaAccessGroupService) DeleteSchema(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *SchemaAccessGroupService) NewSchema(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ type SchemaNewParams struct

+ Description param.Field[string]

+ Document param.Field[string]

+ IsPrivate param.Field[bool]

+ Slug param.Field[string]

+ Title param.Field[string]

+ Version param.Field[string]

+ func (r SchemaNewParams) MarshalJSON() (data []byte, err error)

+ type SchemaNewResponse struct

+ JSON schemaNewResponseJSON

+ UID string

+ func (r *SchemaNewResponse) UnmarshalJSON(data []byte) (err error)

+ type SchemaService struct

+ AccessGroup *SchemaAccessGroupService

+ Options []option.RequestOption

+ Version *SchemaVersionService

+ func NewSchemaService(opts ...option.RequestOption) (r *SchemaService)

+ func (r *SchemaService) Delete(ctx context.Context, namespace string, slug string, ...) (res *map[string]interface{}, err error)

+ func (r *SchemaService) List(ctx context.Context, namespace string, opts ...option.RequestOption) (res *[]Schema, err error)

+ func (r *SchemaService) New(ctx context.Context, namespace string, body SchemaNewParams, ...) (res *SchemaNewResponse, err error)

+ func (r *SchemaService) Update(ctx context.Context, namespace string, slug string, body SchemaUpdateParams, ...) (res *map[string]interface{}, err error)

+ type SchemaUpdateParams struct

+ Description param.Field[string]

+ IsPrivate param.Field[bool]

+ Title param.Field[string]

+ func (r SchemaUpdateParams) MarshalJSON() (data []byte, err error)

+ type SchemaVersion struct

+ CreatedAt int64

+ JSON schemaVersionJSON

+ UID string

+ UpdatedAt int64

+ Version string

+ func (r *SchemaVersion) UnmarshalJSON(data []byte) (err error)

+ type SchemaVersionNewSchemaParams struct

+ Document param.Field[string]

+ Version param.Field[string]

+ func (r SchemaVersionNewSchemaParams) MarshalJSON() (data []byte, err error)

+ type SchemaVersionNewSchemaResponse struct

+ JSON schemaVersionNewSchemaResponseJSON

+ UID string

+ func (r *SchemaVersionNewSchemaResponse) UnmarshalJSON(data []byte) (err error)

+ type SchemaVersionService struct

+ Options []option.RequestOption

+ func NewSchemaVersionService(opts ...option.RequestOption) (r *SchemaVersionService)

+ func (r *SchemaVersionService) DeleteSchema(ctx context.Context, namespace string, slug string, semver string, ...) (res *map[string]interface{}, err error)

+ func (r *SchemaVersionService) GetSchema(ctx context.Context, namespace string, slug string, semver string, ...) (res *string, err error)

+ func (r *SchemaVersionService) NewSchema(ctx context.Context, namespace string, slug string, ...) (res *SchemaVersionNewSchemaResponse, err error)

+ type Team struct

+ ImageURI string

+ JSON teamJSON

+ Name string

+ Slug string

+ Theme string

+ UID string

+ func (r *Team) UnmarshalJSON(data []byte) (err error)

+ type TeamService struct

+ Options []option.RequestOption

+ func NewTeamService(opts ...option.RequestOption) (r *TeamService)

+ func (r *TeamService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Team, err error)

+ type Theme struct

+ Description string

+ JSON themeJSON

+ Name string

+ Slug string

+ UID string

+ func (r *Theme) UnmarshalJSON(data []byte) (err error)

+ type ThemeNewParams struct

+ Description param.Field[string]

+ Document param.Field[string]

+ Name param.Field[string]

+ Slug param.Field[string]

+ func (r ThemeNewParams) MarshalJSON() (data []byte, err error)

+ type ThemeNewResponse struct

+ JSON themeNewResponseJSON

+ UID string

+ func (r *ThemeNewResponse) UnmarshalJSON(data []byte) (err error)

+ type ThemeReplaceDocumentParams struct

+ Document param.Field[string]

+ func (r ThemeReplaceDocumentParams) MarshalJSON() (data []byte, err error)

+ type ThemeService struct

+ Options []option.RequestOption

+ func NewThemeService(opts ...option.RequestOption) (r *ThemeService)

+ func (r *ThemeService) Delete(ctx context.Context, slug string, opts ...option.RequestOption) (res *map[string]interface{}, err error)

+ func (r *ThemeService) Get(ctx context.Context, slug string, opts ...option.RequestOption) (res *string, err error)

+ func (r *ThemeService) List(ctx context.Context, opts ...option.RequestOption) (res *[]Theme, err error)

+ func (r *ThemeService) New(ctx context.Context, body ThemeNewParams, opts ...option.RequestOption) (res *ThemeNewResponse, err error)

+ func (r *ThemeService) ReplaceDocument(ctx context.Context, slug string, body ThemeReplaceDocumentParams, ...) (res *map[string]interface{}, err error)

+ func (r *ThemeService) Update(ctx context.Context, slug string, body ThemeUpdateParams, ...) (res *map[string]interface{}, err error)

+ type ThemeUpdateParams struct

+ Description param.Field[string]

+ Name param.Field[string]

+ func (r ThemeUpdateParams) MarshalJSON() (data []byte, err error)

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL