Module
protocol (Go)
github.com/riducms/ridu/protocol — Advanced stable REST wire envelopes shared by the HTTP runtime, generators, SDK, admin, and transport tests.
Protocol 1
constant protocol.CurrentVersionThe framework REST wire-protocol version.
Errors 4
type protocol.ErrorCodeA stable machine-readable failure category.
type protocol.ErrorEnvelopeThe response returned by every failed HTTP operation.
type protocol.ErrorPayloadStable structured error data.
type protocol.ValidationIssueOne invalid input path.
Content envelopes 9
type protocol.PaginationStable page metadata independent of document type.
type protocol.PageEnvelopeOne typed document page.
type protocol.DocumentEnvelopeOne typed document.
type protocol.BulkEnvelopeDocuments changed by one atomic bulk operation.
type protocol.CountEnvelopeExact cardinality after caller and access filters.
type protocol.JoinMutationInputExplicit inverse-relation additions and removals.
type protocol.JoinMutationEnvelopeThe refreshed source document and applied inverse-relation delta counts.
type protocol.PreferenceEnvelopeOne typed actor-owned admin preference value.
type protocol.DeleteEnvelopeA stable acknowledgement for deleting one owned resource.
Authentication 13
type protocol.AuthSessionFramework session metadata plus a typed authenticated user.
type protocol.AuthSessionInfoSafe device/session metadata.
type protocol.AuthSessionsEnvelopeSafe session metadata owned by the current identity.
type protocol.SessionEnvelopeOne typed current or newly rotated session.
type protocol.LogoutEnvelopeA successful session logout acknowledgement.
type protocol.AuthActionEnvelopeA non-secret success acknowledgement for an auth lifecycle action.
type protocol.AuthBootstrapEnvelopeA non-secret indication that the configured admin collection still allows first-user setup.
type protocol.APIKeyA newly minted API key including its one-time bearer secret.
type protocol.APIKeyInfoRetrievable API-key metadata without its bearer secret.
type protocol.APIKeyEnvelopeOne newly created API key including its one-time secret.
type protocol.APIKeysEnvelopeSafe metadata for the current identity's API keys.
type protocol.PreviewTokenA short-lived read-only resource capability.
type protocol.PreviewTokenEnvelopeOne newly minted exact-resource preview capability.
Authoring state 11
type protocol.AccessCapabilitiesEnvelopeEvaluated operation and field access for one actor and optional document/input.
type protocol.OperationCapabilitiesBoolean operation permissions for one evaluated resource state.
type protocol.FieldCapabilitiesBoolean create, read, and update permissions for one field path.
type protocol.CollectionSelectionInputA caller filter and optional trash mode for bounded selection preflight.
type protocol.CollectionSelectionItemOne frozen document ID and its evaluated authoring capabilities.
type protocol.CollectionSelectionEnvelopeOne complete bounded read-visible selection.
type protocol.DocumentLockEnvelopeCurrent authoring lock and current-actor state.
type protocol.DocumentLockSafe persisted editor-lock metadata.
type protocol.ScheduledPublishSafe queued-publish metadata.
type protocol.ScheduledPublishEnvelopeOne created scheduled-publish record.
type protocol.ScheduledPublishesEnvelopeQueued, running, and actionable failed publish records for one document.
Schema 1
type protocol.SchemaEnvelopeResolved declarative schema for trusted tooling and the admin.
Constants 13
constant protocol.ErrorAccessPublic constant ErrorAccess from github.com/riducms/ridu/protocol.
constant protocol.ErrorAuthFeatureDisabledPublic constant ErrorAuthFeatureDisabled from github.com/riducms/ridu/protocol.
constant protocol.ErrorBadRequestPublic constant ErrorBadRequest from github.com/riducms/ridu/protocol.
constant protocol.ErrorConflictPublic constant ErrorConflict from github.com/riducms/ridu/protocol.
constant protocol.ErrorDeleteRestrictedPublic constant ErrorDeleteRestricted from github.com/riducms/ridu/protocol.
constant protocol.ErrorEmailNotVerifiedPublic constant ErrorEmailNotVerified from github.com/riducms/ridu/protocol.
constant protocol.ErrorInternalPublic constant ErrorInternal from github.com/riducms/ridu/protocol.
constant protocol.ErrorInvalidAuthTokenPublic constant ErrorInvalidAuthToken from github.com/riducms/ridu/protocol.
constant protocol.ErrorInvalidPreviewTokenPublic constant ErrorInvalidPreviewToken from github.com/riducms/ridu/protocol.
constant protocol.ErrorNotFoundPublic constant ErrorNotFound from github.com/riducms/ridu/protocol.
constant protocol.ErrorRateLimitedPublic constant ErrorRateLimited from github.com/riducms/ridu/protocol.
constant protocol.ErrorSelectionTooLargePublic constant ErrorSelectionTooLarge from github.com/riducms/ridu/protocol.
constant protocol.ErrorValidationPublic constant ErrorValidation from github.com/riducms/ridu/protocol.