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.ScheduledPublicationSafe queued-publish metadata.
type protocol.ScheduledPublicationEnvelopeOne created scheduled-publish record.
type protocol.ScheduledPublicationsEnvelopeQueued, running, and actionable failed publish records for one document.
Schema 1
type protocol.SchemaEnvelopeResolved declarative schema for trusted tooling and the admin.
Constants 43
constant protocol.ErrorAccessconstant protocol.ErrorAuthFeatureDisabledconstant protocol.ErrorBadRequestconstant protocol.ErrorConflictconstant protocol.ErrorDeleteRestrictedconstant protocol.ErrorEmailNotVerifiedconstant protocol.ErrorInternalconstant protocol.ErrorInvalidAuthTokenconstant protocol.ErrorInvalidPreviewTokenconstant protocol.ErrorNotFoundconstant protocol.ErrorRateLimitedconstant protocol.ErrorSelectionTooLargeconstant protocol.ErrorValidationconstant protocol.AdminPreparedRouteAccountconstant protocol.AdminPreparedRouteCollectionAPIconstant protocol.AdminPreparedRouteCollectionCreateconstant protocol.AdminPreparedRouteCollectionDocumentconstant protocol.AdminPreparedRouteCollectionListconstant protocol.AdminPreparedRouteCollectionTrashconstant protocol.AdminPreparedRouteCollectionVersionsconstant protocol.AdminPreparedRouteCustomconstant protocol.AdminPreparedRouteDashboardconstant protocol.AdminPreparedRouteErrorconstant protocol.AdminPreparedRouteFallbackconstant protocol.AdminPreparedRouteGlobalAPIconstant protocol.AdminPreparedRouteGlobalDocumentconstant protocol.AdminPreparedRouteGlobalVersionsconstant protocol.AdminPreparedRouteLoginconstant protocol.AdminPreparedRouteNotFoundconstant protocol.AdminPreparedRoutePreparedconstant protocol.AdminPreparedRouteRedirectconstant protocol.AdminPreparedRouteReloadconstant protocol.AdminPreparedRouteSecurityconstant protocol.AdminPreparedRouteSetupconstant protocol.AdminPreparedRouteStateMediaTypeconstant protocol.AdminPreparedRouteStateVersionconstant protocol.AdminPreparedRouteUploadconstant protocol.ErrorBadQueryconstant protocol.ErrorInvalidCredentialconstant protocol.ErrorPublishRequiredconstant protocol.ErrorRejectedconstant protocol.SessionTransportCookieconstant protocol.SessionTransportToken
Types 33
type protocol.AdminCollectionListCountV1type protocol.AdminCollectionListDataV1type protocol.AdminCollectionListPageV1type protocol.AdminCollectionListPreferencesV1type protocol.AdminCollectionListPreferenceV1type protocol.AdminCollectionListQueryV1type protocol.AdminCreateDataV1type protocol.AdminDocumentDataV1type protocol.AdminPreparedNavigationV1type protocol.AdminPreparedRouteDataV1type protocol.AdminPreparedRouteDiagnosticV1type protocol.AdminPreparedRouteKindV1type protocol.AdminPreparedRouteOutcomeV1type protocol.AdminPreparedRouteStateV1type protocol.AdminPreparedRuntimeV1type protocol.AdminReadResultV1type protocol.AdminSecurityDataV1type protocol.AdminVersionsDataV1type protocol.CollectionPageAccesstype protocol.CollectionPageEnvelopetype protocol.DocumentVersiontype protocol.LiveValidationEmbeddedScopetype protocol.LiveValidationEnvelopetype protocol.LiveValidationEvaluationtype protocol.LiveValidationRequesttype protocol.LoginRequesttype protocol.SessionTokenEnvelopetype protocol.SessionTransporttype protocol.UploadGranttype protocol.UploadGrantRequestItemtype protocol.UploadGrantsEnvelopetype protocol.UploadGrantsRequesttype protocol.UploadImageEdit