Skip to content

Latest commit

 

History

History
2037 lines (1905 loc) · 125 KB

File metadata and controls

2037 lines (1905 loc) · 125 KB

Public API Inventory

This inventory is generated from docs/package-classification.tsv and non-test Go source files for root packages classified as stable or compatibility-only.

Added version currently records the v3 compatibility surface, not the original historical commit for each symbol. Use release notes for finer history when a symbol was added after the v3 baseline.

github.com/aatuh/api-toolkit/v4/apiclient

Stability tier: stable

Symbol Kind Added version Deprecation status
APIKeyTransport type v3 compatibility surface active
APIKeyTransport.Base field v3 compatibility surface active
APIKeyTransport.HeaderName field v3 compatibility surface active
APIKeyTransport.Key field v3 compatibility surface active
APIKeyTransport.RoundTrip method v3 compatibility surface active
APIKeyTransport.Scheme field v3 compatibility surface active
CursorIterator type v3 compatibility surface active
CursorIterator.Cursor field v3 compatibility surface active
CursorIterator.Err method v3 compatibility surface active
CursorIterator.Fetch field v3 compatibility surface active
CursorIterator.Items method v3 compatibility surface active
CursorIterator.Next method v3 compatibility surface active
CursorPage type v3 compatibility surface active
CursorPage.Items field v3 compatibility surface active
CursorPage.NextCursor field v3 compatibility surface active
CursorPageFunc type v3 compatibility surface active
DecodeProblem func v3 compatibility surface active
DoJSON func v3 compatibility surface active
PreconditionHeaders func v3 compatibility surface active
ProblemError type v3 compatibility surface active
ProblemError.Error method v3 compatibility surface active
ProblemError.Problem field v3 compatibility surface active
ProblemError.StatusCode field v3 compatibility surface active
RetryAfter func v3 compatibility surface active
WebhookSignerTransport type v3 compatibility surface active
WebhookSignerTransport.Base field v3 compatibility surface active
WebhookSignerTransport.HeaderName field v3 compatibility surface active
WebhookSignerTransport.RoundTrip method v3 compatibility surface active
WebhookSignerTransport.Signer field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/apitest

Stability tier: stable

Symbol Kind Added version Deprecation status
AssertDeprecationHeaders func v3 compatibility surface active
AssertETag func v3 compatibility surface active
AssertHeader func v3 compatibility surface active
AssertJSON func v3 compatibility surface active
AssertOpenAPIGolden func v3 compatibility surface active
AssertOperationAccepted func v3 compatibility surface active
AssertPagination func v3 compatibility surface active
AssertProblem func v3 compatibility surface active
AssertProblemCode func v3 compatibility surface active
AssertRateLimitHeaders func v3 compatibility surface active
AssertValidationFields func v3 compatibility surface active
AssertWebhookSignature func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/authorization

Stability tier: stable

Symbol Kind Added version Deprecation status
Actor type v3 compatibility surface active
Actor.UserID field v3 compatibility surface active
ActorFromContext func v3 compatibility surface active
AllowlistAuthorizer type v3 compatibility surface active
AllowlistAuthorizer.Allow method v3 compatibility surface active
AllowlistAuthorizer.AllowAny method v3 compatibility surface active
AllowlistAuthorizer.AllowFunc method v3 compatibility surface active
AllowlistAuthorizer.Can method v3 compatibility surface active
ApplyScope func v3 compatibility surface active
Authorizer type v3 compatibility surface active
Authorizer.Can interface method v3 compatibility surface active
AuthorizerFunc type v3 compatibility surface active
AuthorizerFunc.Can method v3 compatibility surface active
MaskFields func v3 compatibility surface active
NewAllowlistAuthorizer func v3 compatibility surface active
NewPolicyAuthorizer func v3 compatibility surface active
Owner type v3 compatibility surface active
Owner.OwnerID interface method v3 compatibility surface active
PolicyAuthorizer type v3 compatibility surface active
PolicyAuthorizer.Can method v3 compatibility surface active
PolicyAuthorizerOptions type v3 compatibility surface active
PolicyAuthorizerOptions.ContextProvider field v3 compatibility surface active
PolicyAuthorizerOptions.DenyOnError field v3 compatibility surface active
PolicyContextProvider type v3 compatibility surface active
PolicyDecision type v3 compatibility surface active
PolicyDecision.Allow field v3 compatibility surface active
PolicyDecision.Data field v3 compatibility surface active
PolicyDecision.Reason field v3 compatibility surface active
PolicyEngine type v3 compatibility surface active
PolicyEngine.Evaluate interface method v3 compatibility surface active
PolicyRequest type v3 compatibility surface active
PolicyRequest.Action field v3 compatibility surface active
PolicyRequest.Context field v3 compatibility surface active
PolicyRequest.Resource field v3 compatibility surface active
PolicyRequest.Subject field v3 compatibility surface active
ProjectFields func v3 compatibility surface active
Require func v3 compatibility surface active
RequireOwner func v3 compatibility surface active
RequireOwnerID func v3 compatibility surface active
RequireTenant func v3 compatibility surface active
Scope type v3 compatibility surface active
Scope.Filters method v3 compatibility surface active
Scope.TenantID field v3 compatibility surface active
Scope.UserID field v3 compatibility surface active
ScopeFromContext func v3 compatibility surface active
TenantIDFromContext func v3 compatibility surface active
TenantOwned type v3 compatibility surface active
TenantOwned.TenantID interface method v3 compatibility surface active
WithActor func v3 compatibility surface active
WithScope func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/binding

Stability tier: stable

Symbol Kind Added version Deprecation status
DecodeJSON func v3 compatibility surface active
DecodePath func v3 compatibility surface active
DecodeQuery func v3 compatibility surface active
JSONConfig type v3 compatibility surface active
JSONConfig.AllowUnknownFields field v3 compatibility surface active
JSONConfig.MaxBytes field v3 compatibility surface active
JSONConfig.RequireObject field v3 compatibility surface active
JSONConfig.RequiredMode field v3 compatibility surface active
PathConfig type v3 compatibility surface active
PathConfig.HasParam field v3 compatibility surface active
PathConfig.Param field v3 compatibility surface active
PathConfig.RequiredMode field v3 compatibility surface active
PublicError type v3 compatibility surface active
PublicError.PublicMessage interface method v3 compatibility surface active
QueryConfig type v3 compatibility surface active
QueryConfig.RequiredMode field v3 compatibility surface active
RequiredMode type v3 compatibility surface active
RequiredModeNonZero const v3 compatibility surface active
RequiredModePresent const v3 compatibility surface active
ValidationProblem func v3 compatibility surface active
WriteValidationProblem func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/compat/billing

Stability tier: compatibility-only

Symbol Kind Added version Deprecation status
BillingPortalFlowAfterCompletion type v3 compatibility surface active
BillingPortalFlowAfterCompletion.RedirectReturnURL field v3 compatibility surface active
BillingPortalFlowAfterCompletion.Type field v3 compatibility surface active
BillingPortalFlowAfterCompletionType type v3 compatibility surface active
BillingPortalFlowAfterCompletionTypeRedirect const v3 compatibility surface active
BillingPortalFlowData type v3 compatibility surface active
BillingPortalFlowData.AfterCompletion field v3 compatibility surface active
BillingPortalFlowData.SubscriptionUpdateConfirm field v3 compatibility surface active
BillingPortalFlowData.Type field v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirm type v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirm.Items field v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirm.SubscriptionID field v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirmItem type v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirmItem.PriceID field v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirmItem.Quantity field v3 compatibility surface active
BillingPortalFlowSubscriptionUpdateConfirmItem.SubscriptionItemID field v3 compatibility surface active
BillingPortalFlowType type v3 compatibility surface active
BillingPortalFlowTypeSubscriptionUpdateConfirm const v3 compatibility surface active
BillingPortalSession type v3 compatibility surface active
BillingPortalSession.ID field v3 compatibility surface active
BillingPortalSession.URL field v3 compatibility surface active
BillingPortalSessionInput type v3 compatibility surface active
BillingPortalSessionInput.CustomerID field v3 compatibility surface active
BillingPortalSessionInput.Flow field v3 compatibility surface active
BillingPortalSessionInput.Locale field v3 compatibility surface active
BillingPortalSessionInput.ReturnURL field v3 compatibility surface active
BillingProvider type v3 compatibility surface active
BillingProvider.CreateBillingPortalSession interface method v3 compatibility surface active
BillingProvider.CreateCustomer interface method v3 compatibility surface active
BillingProvider.CreateInvoice interface method v3 compatibility surface active
BillingProvider.CreateInvoiceItem interface method v3 compatibility surface active
BillingProvider.CreateSetupIntent interface method v3 compatibility surface active
BillingProvider.FinalizeInvoice interface method v3 compatibility surface active
BillingProvider.PayInvoice interface method v3 compatibility surface active
BillingProvider.RetrieveInvoice interface method v3 compatibility surface active
BillingProvider.RetrieveInvoiceItem interface method v3 compatibility surface active
BillingProvider.RetrievePaymentMethod interface method v3 compatibility surface active
BillingProvider.SetCustomerDefaultPaymentMethod interface method v3 compatibility surface active
BillingProvider.UpdateCustomer interface method v3 compatibility surface active
BillingProvider.UpdateInvoiceItem interface method v3 compatibility surface active
CheckoutSession type v3 compatibility surface active
CheckoutSession.ID field v3 compatibility surface active
CheckoutSession.URL field v3 compatibility surface active
CheckoutSessionRequest type v3 compatibility surface active
CheckoutSessionRequest.Amount field v3 compatibility surface active
CheckoutSessionRequest.CancelURL field v3 compatibility surface active
CheckoutSessionRequest.ClientReferenceID field v3 compatibility surface active
CheckoutSessionRequest.Currency field v3 compatibility surface active
CheckoutSessionRequest.CustomerEmail field v3 compatibility surface active
CheckoutSessionRequest.CustomerID field v3 compatibility surface active
CheckoutSessionRequest.Locale field v3 compatibility surface active
CheckoutSessionRequest.Metadata field v3 compatibility surface active
CheckoutSessionRequest.Mode field v3 compatibility surface active
CheckoutSessionRequest.PriceID field v3 compatibility surface active
CheckoutSessionRequest.SubscriptionMetadata field v3 compatibility surface active
CheckoutSessionRequest.SuccessURL field v3 compatibility surface active
Customer type v3 compatibility surface active
Customer.ID field v3 compatibility surface active
CustomerAddress type v3 compatibility surface active
CustomerAddress.City field v3 compatibility surface active
CustomerAddress.Country field v3 compatibility surface active
CustomerAddress.Line1 field v3 compatibility surface active
CustomerAddress.Line2 field v3 compatibility surface active
CustomerAddress.PostalCode field v3 compatibility surface active
CustomerAddress.State field v3 compatibility surface active
CustomerInput type v3 compatibility surface active
CustomerInput.Address field v3 compatibility surface active
CustomerInput.Email field v3 compatibility surface active
CustomerInput.Metadata field v3 compatibility surface active
CustomerInput.Name field v3 compatibility surface active
CustomerInput.Phone field v3 compatibility surface active
Invoice type v3 compatibility surface active
Invoice.AmountDue field v3 compatibility surface active
Invoice.AmountPaid field v3 compatibility surface active
Invoice.CreatedAt field v3 compatibility surface active
Invoice.Currency field v3 compatibility surface active
Invoice.DueDate field v3 compatibility surface active
Invoice.FinalizedAt field v3 compatibility surface active
Invoice.HostedInvoiceURL field v3 compatibility surface active
Invoice.ID field v3 compatibility surface active
Invoice.PaidAt field v3 compatibility surface active
Invoice.Status field v3 compatibility surface active
InvoiceInput type v3 compatibility surface active
InvoiceInput.AutoAdvance field v3 compatibility surface active
InvoiceInput.AutomaticTax field v3 compatibility surface active
InvoiceInput.CollectionMethod field v3 compatibility surface active
InvoiceInput.CustomerID field v3 compatibility surface active
InvoiceInput.DueDays field v3 compatibility surface active
InvoiceInput.IdempotencyKey field v3 compatibility surface active
InvoiceInput.Metadata field v3 compatibility surface active
InvoiceInput.PendingInvoiceItemsBehavior field v3 compatibility surface active
InvoiceItem type v3 compatibility surface active
InvoiceItem.ID field v3 compatibility surface active
InvoiceItem.InvoiceID field v3 compatibility surface active
InvoiceItemInput type v3 compatibility surface active
InvoiceItemInput.Amount field v3 compatibility surface active
InvoiceItemInput.Currency field v3 compatibility surface active
InvoiceItemInput.CustomerID field v3 compatibility surface active
InvoiceItemInput.Description field v3 compatibility surface active
InvoiceItemInput.IdempotencyKey field v3 compatibility surface active
InvoiceItemInput.Metadata field v3 compatibility surface active
InvoiceItemInput.TaxBehavior field v3 compatibility surface active
InvoiceItemUpdate type v3 compatibility surface active
InvoiceItemUpdate.TaxBehavior field v3 compatibility surface active
PaymentMethod type v3 compatibility surface active
PaymentMethod.Brand field v3 compatibility surface active
PaymentMethod.ExpMonth field v3 compatibility surface active
PaymentMethod.ExpYear field v3 compatibility surface active
PaymentMethod.ID field v3 compatibility surface active
PaymentMethod.Last4 field v3 compatibility surface active
PaymentProvider type v3 compatibility surface active
PaymentProvider.CreateCheckoutSession interface method v3 compatibility surface active
PaymentProvider.ListPrices interface method v3 compatibility surface active
PaymentProvider.ParseWebhook interface method v3 compatibility surface active
Price type v3 compatibility surface active
Price.Active field v3 compatibility surface active
Price.Currency field v3 compatibility surface active
Price.ID field v3 compatibility surface active
Price.Metadata field v3 compatibility surface active
Price.Nickname field v3 compatibility surface active
Price.ProductID field v3 compatibility surface active
Price.UnitAmount field v3 compatibility surface active
SetupIntent type v3 compatibility surface active
SetupIntent.ClientSecret field v3 compatibility surface active
SetupIntent.CustomerID field v3 compatibility surface active
SetupIntent.ID field v3 compatibility surface active
SetupIntent.PaymentMethodID field v3 compatibility surface active
SetupIntentInput type v3 compatibility surface active
SetupIntentInput.CustomerID field v3 compatibility surface active
SetupIntentInput.Metadata field v3 compatibility surface active
SetupIntentInput.Usage field v3 compatibility surface active
WebhookEvent type v3 compatibility surface active
WebhookEvent.CreatedAt field v3 compatibility surface active
WebhookEvent.ID field v3 compatibility surface active
WebhookEvent.Payload field v3 compatibility surface active
WebhookEvent.Type field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/contracttest

Stability tier: stable

Symbol Kind Added version Deprecation status
AssertAllOperationsHaveOperationID func v3 compatibility surface active
AssertOpenAPICompatible func v3 compatibility surface active
AssertOperationHasAdminPolicy func v3 compatibility surface active
AssertOperationHasAdminPolicyNamed func v3 compatibility surface active
AssertOperationHasIdempotencyPolicy func v3 compatibility surface active
AssertOperationHasIdempotencyPolicyHeader func v3 compatibility surface active
AssertOperationHasProblemResponse func v3 compatibility surface active
AssertOperationHasProblemResponses func v3 compatibility surface active
AssertOperationHasRateLimitPolicy func v3 compatibility surface active
AssertOperationHasResponse func v3 compatibility surface active
AssertOperationHasSecurity func v3 compatibility surface active
AssertOperationHasSecurityScopes func v3 compatibility surface active
AssertOperationHasTenantPolicy func v3 compatibility surface active
AssertOperationHasTenantPolicySource func v3 compatibility surface active
AssertOperationID func v3 compatibility surface active
AssertProblemCatalogHas func v3 compatibility surface active
AssertRegistryValid func v3 compatibility surface active
AssertRouteCoverage func v3 compatibility surface active
AssertSecuritySchemesDefined func v3 compatibility surface active
AssertUniqueOperationIDs func v3 compatibility surface active
GoldenOpenAPI func v3 compatibility surface active
NormalizeOpenAPI func v3 compatibility surface active
OpenAPICompatibilityFindings func v3 compatibility surface active
SecuritySchemeDefinitionFindings func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/email

Stability tier: stable

Symbol Kind Added version Deprecation status
Message type v3 compatibility surface active
Message.From field v3 compatibility surface active
Message.HTML field v3 compatibility surface active
Message.ReplyTo field v3 compatibility surface active
Message.Subject field v3 compatibility surface active
Message.Text field v3 compatibility surface active
Message.To field v3 compatibility surface active
Sender type v3 compatibility surface active
Sender.Send interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/endpoints/docs

Stability tier: stable

Symbol Kind Added version Deprecation status
Config type v3 compatibility surface active
Config.Contact field v3 compatibility surface active
Config.Description field v3 compatibility surface active
Config.EnableHTML field v3 compatibility surface active
Config.EnableJSON field v3 compatibility surface active
Config.EnableYAML field v3 compatibility surface active
Config.HTMLMode field v3 compatibility surface active
Config.License field v3 compatibility surface active
Config.Paths field v3 compatibility surface active
Config.Title field v3 compatibility surface active
Config.Version field v3 compatibility surface active
DefaultPaths func v3 compatibility surface active
HTMLMode type v3 compatibility surface active
HTMLModeProvider type v3 compatibility surface active
HTMLModeProvider.HTMLMode interface method v3 compatibility surface active
HTMLModeStatic const v3 compatibility surface active
HTMLModeSwaggerUI const v3 compatibility surface active
Handler type v3 compatibility surface active
Handler.HTMLHandler method v3 compatibility surface active
Handler.InfoHandler method v3 compatibility surface active
Handler.Middleware method v3 compatibility surface active
Handler.OpenAPIHandler method v3 compatibility surface active
Handler.RegisterCustomRoutes method v3 compatibility surface active
Handler.RegisterCustomRoutesTo method v3 compatibility surface active
Handler.RegisterRoutes method v3 compatibility surface active
Handler.RegisterRoutesTo method v3 compatibility surface active
Handler.VersionHandler method v3 compatibility surface active
Info type v3 compatibility surface active
Manager type v3 compatibility surface active
Manager.GetHTML method v3 compatibility surface active
Manager.GetInfo method v3 compatibility surface active
Manager.GetOpenAPI method v3 compatibility surface active
Manager.GetVersion method v3 compatibility surface active
Manager.HTMLMode method v3 compatibility surface active
Manager.RegisterProvider method v3 compatibility surface active
Manager.ServeHTML method v3 compatibility surface active
Manager.ServeInfo method v3 compatibility surface active
Manager.ServeOpenAPI method v3 compatibility surface active
Manager.ServeVersion method v3 compatibility surface active
ManagerContract type v3 compatibility surface active
ManagerContract.GetHTML interface method v3 compatibility surface active
ManagerContract.GetInfo interface method v3 compatibility surface active
ManagerContract.GetOpenAPI interface method v3 compatibility surface active
ManagerContract.GetVersion interface method v3 compatibility surface active
ManagerContract.RegisterProvider interface method v3 compatibility surface active
ManagerContract.ServeHTML interface method v3 compatibility surface active
ManagerContract.ServeInfo interface method v3 compatibility surface active
ManagerContract.ServeOpenAPI interface method v3 compatibility surface active
ManagerContract.ServeVersion interface method v3 compatibility surface active
New func v3 compatibility surface active
NewDefaultHandler func v3 compatibility surface active
NewHandler func v3 compatibility surface active
NewStrict func v3 compatibility surface active
NewSwaggerUI func v3 compatibility surface active
NewWithConfig func v3 compatibility surface active
Paths type v3 compatibility surface active
Paths.HTML field v3 compatibility surface active
Paths.Info field v3 compatibility surface active
Paths.OpenAPI field v3 compatibility surface active
Paths.Version field v3 compatibility surface active
Provider type v3 compatibility surface active
Provider.GetHTML interface method v3 compatibility surface active
Provider.GetInfo interface method v3 compatibility surface active
Provider.GetOpenAPI interface method v3 compatibility surface active
Provider.GetVersion interface method v3 compatibility surface active
RouteRegistrar type v3 compatibility surface active
RouteRegistrar.Get interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/endpoints/health

Stability tier: stable

Symbol Kind Added version Deprecation status
BasicChecker type v3 compatibility surface active
BasicChecker.Check method v3 compatibility surface active
BasicChecker.Name method v3 compatibility surface active
CachedManager type v3 compatibility surface active
CachedManager.CachedHealth interface method v3 compatibility surface active
Checker type v3 compatibility surface active
Checker.Check interface method v3 compatibility surface active
Checker.Name interface method v3 compatibility surface active
CompositeChecker type v3 compatibility surface active
CompositeChecker.Check method v3 compatibility surface active
CompositeChecker.Name method v3 compatibility surface active
Config type v3 compatibility surface active
Config.CacheDuration field v3 compatibility surface active
Config.Clock field v3 compatibility surface active
Config.EnableCaching field v3 compatibility surface active
Config.EnableDetailed field v3 compatibility surface active
Config.LivenessChecks field v3 compatibility surface active
Config.ReadinessChecks field v3 compatibility surface active
Config.Timeout field v3 compatibility surface active
Config.Validate method v3 compatibility surface active
CustomChecker type v3 compatibility surface active
CustomChecker.Check method v3 compatibility surface active
CustomChecker.Name method v3 compatibility surface active
DatabaseChecker type v3 compatibility surface active
DatabaseChecker.Check method v3 compatibility surface active
DatabaseChecker.Name method v3 compatibility surface active
DatabasePool type v3 compatibility surface active
DatabasePool.Ping interface method v3 compatibility surface active
DatabasePoolSnapshot type v3 compatibility surface active
DatabasePoolSnapshot.AcquireCount field v3 compatibility surface active
DatabasePoolSnapshot.AcquiredConns field v3 compatibility surface active
DatabasePoolSnapshot.IdleConns field v3 compatibility surface active
DatabasePoolSnapshot.MaxConns field v3 compatibility surface active
DatabasePoolSnapshot.TotalConns field v3 compatibility surface active
DatabasePoolSnapshotProvider type v3 compatibility surface active
DatabasePoolSnapshotProvider.StatSnapshot interface method v3 compatibility surface active
DefaultConfig func v3 compatibility surface active
DefaultHealthPaths func v3 compatibility surface active
DetailedHealthResponse type v3 compatibility surface active
DetailedHealthResponse.Checks field v3 compatibility surface active
DetailedHealthResponse.Status field v3 compatibility surface active
DetailedHealthResponse.Summary field v3 compatibility surface active
DetailedHealthResponse.Timestamp field v3 compatibility surface active
DetailedManager type v3 compatibility surface active
DetailedManager.DetailedHealthEnabled interface method v3 compatibility surface active
DetailedResponse type v3 compatibility surface active
DetailedResponse.Checks field v3 compatibility surface active
DetailedResponse.Status field v3 compatibility surface active
DetailedResponse.Summary field v3 compatibility surface active
DetailedResponse.Timestamp field v3 compatibility surface active
DurationLoader type v3 compatibility surface active
DurationLoader.Duration interface method v3 compatibility surface active
HTTPChecker type v3 compatibility surface active
HTTPChecker.Check method v3 compatibility surface active
HTTPChecker.Name method v3 compatibility surface active
HTTPCheckerOption type v3 compatibility surface active
Handler type v3 compatibility surface active
Handler.DetailedHealthHandler method v3 compatibility surface active
Handler.HealthHandler method v3 compatibility surface active
Handler.LivenessHandler method v3 compatibility surface active
Handler.Middleware method v3 compatibility surface active
Handler.ReadinessHandler method v3 compatibility surface active
Handler.RegisterAdminDetailedHealthRoute method v3 compatibility surface active
Handler.RegisterCustomRoutes method v3 compatibility surface active
Handler.RegisterCustomRoutesTo method v3 compatibility surface active
Handler.RegisterPublicRoutesTo method v3 compatibility surface active
Handler.RegisterRoutes method v3 compatibility surface active
Handler.RegisterRoutesTo method v3 compatibility surface active
HealthPaths type v3 compatibility surface active
HealthPaths.DetailedHealth field v3 compatibility surface active
HealthPaths.Health field v3 compatibility surface active
HealthPaths.Liveness field v3 compatibility surface active
HealthPaths.Readiness field v3 compatibility surface active
HealthResponse type v3 compatibility surface active
HealthResponse.Message field v3 compatibility surface active
HealthResponse.Status field v3 compatibility surface active
HealthResponse.Timestamp field v3 compatibility surface active
HealthResult type v3 compatibility surface active
HealthResult.Details field v3 compatibility surface active
HealthResult.Duration field v3 compatibility surface active
HealthResult.Message field v3 compatibility surface active
HealthResult.Status field v3 compatibility surface active
HealthResult.Timestamp field v3 compatibility surface active
HealthStatusFromContext func v3 compatibility surface active
HealthSummary type v3 compatibility surface active
HealthSummary.Degraded field v3 compatibility surface active
HealthSummary.Healthy field v3 compatibility surface active
HealthSummary.Total field v3 compatibility surface active
HealthSummary.Unhealthy field v3 compatibility surface active
HealthSummary.Unknown field v3 compatibility surface active
HealthTimestampFromContext func v3 compatibility surface active
LoadConfig func v3 compatibility surface active
Manager type v3 compatibility surface active
Manager.CachedHealth method v3 compatibility surface active
Manager.DetailedHealthEnabled method v3 compatibility surface active
Manager.GetDetailedHealth method v3 compatibility surface active
Manager.GetHealth method v3 compatibility surface active
Manager.GetLiveness method v3 compatibility surface active
Manager.GetReadiness method v3 compatibility surface active
Manager.RefreshAll method v3 compatibility surface active
Manager.RegisterChecker method v3 compatibility surface active
Manager.RegisterCheckerChecked method v3 compatibility surface active
Manager.RegisterCheckers method v3 compatibility surface active
ManagerContract type v3 compatibility surface active
ManagerContract.GetDetailedHealth interface method v3 compatibility surface active
ManagerContract.GetHealth interface method v3 compatibility surface active
ManagerContract.GetLiveness interface method v3 compatibility surface active
ManagerContract.GetReadiness interface method v3 compatibility surface active
ManagerContract.RegisterChecker interface method v3 compatibility surface active
ManagerContract.RegisterCheckers interface method v3 compatibility surface active
MemoryChecker type v3 compatibility surface active
MemoryChecker.Check method v3 compatibility surface active
MemoryChecker.Name method v3 compatibility surface active
New func v3 compatibility surface active
NewBasicChecker func v3 compatibility surface active
NewBasicHandler func v3 compatibility surface active
NewCompositeChecker func v3 compatibility surface active
NewCustomChecker func v3 compatibility surface active
NewCustomCheckerWithTimeout func v3 compatibility surface active
NewDatabaseChecker func v3 compatibility surface active
NewDefaultHandler func v3 compatibility surface active
NewHTTPChecker func v3 compatibility surface active
NewHandler func v3 compatibility surface active
NewManager func v3 compatibility surface active
NewManagerWithConfig func v3 compatibility surface deprecated
NewMemoryChecker func v3 compatibility surface active
NewPaymentProviderChecker func v3 compatibility surface active
NewScheduler func v3 compatibility surface active
NewWithConfig func v3 compatibility surface deprecated
PaymentProviderChecker type v3 compatibility surface active
PaymentProviderChecker.Check method v3 compatibility surface active
PaymentProviderChecker.Name method v3 compatibility surface active
PaymentProviderCheckerOption type v3 compatibility surface active
RefreshConfig type v3 compatibility surface active
RefreshConfig.CacheDuration field v3 compatibility surface active
RefreshConfig.RefreshInterval field v3 compatibility surface active
RefreshManager type v3 compatibility surface active
RefreshManager.RefreshAll interface method v3 compatibility surface active
Response type v3 compatibility surface active
Response.Message field v3 compatibility surface active
Response.Status field v3 compatibility surface active
Response.Timestamp field v3 compatibility surface active
Result type v3 compatibility surface active
Result.Details field v3 compatibility surface active
Result.Duration field v3 compatibility surface active
Result.Message field v3 compatibility surface active
Result.Status field v3 compatibility surface active
Result.Timestamp field v3 compatibility surface active
RouteRegistrar type v3 compatibility surface active
RouteRegistrar.Get interface method v3 compatibility surface active
Scheduler type v3 compatibility surface active
Scheduler.Start method v3 compatibility surface active
SchedulerConfig type v3 compatibility surface active
SchedulerConfig.Interval field v3 compatibility surface active
SchedulerConfig.Logger field v3 compatibility surface active
SchedulerConfig.OnStatusChange field v3 compatibility surface active
SchedulerConfig.OnUpdate field v3 compatibility surface active
SnapshotDatabasePoolStats func v3 compatibility surface active
Status type v3 compatibility surface active
StatusDegraded const v3 compatibility surface active
StatusHealthy const v3 compatibility surface active
StatusUnhealthy const v3 compatibility surface active
StatusUnknown const v3 compatibility surface active
Summary type v3 compatibility surface active
Summary.Degraded field v3 compatibility surface active
Summary.Healthy field v3 compatibility surface active
Summary.Total field v3 compatibility surface active
Summary.Unhealthy field v3 compatibility surface active
Summary.Unknown field v3 compatibility surface active
WithHTTPClient func v3 compatibility surface active
WithHTTPFailureStatus func v3 compatibility surface active
WithHTTPHeader func v3 compatibility surface active
WithHTTPHeaders func v3 compatibility surface active
WithHTTPMethod func v3 compatibility surface active
WithHTTPSuccessStatuses func v3 compatibility surface active
WithHTTPTimeout func v3 compatibility surface active
WithPaymentProviderFailureStatus func v3 compatibility surface active
WithPaymentProviderName func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/endpoints/list

Stability tier: stable

Symbol Kind Added version Deprecation status
CursorCodec type v3 compatibility surface active
CursorCodec.Decode interface method v3 compatibility surface active
CursorCodec.Encode interface method v3 compatibility surface active
CursorMeta type v3 compatibility surface active
CursorMeta.Count field v3 compatibility surface active
CursorMeta.Cursor field v3 compatibility surface active
CursorMeta.Limit field v3 compatibility surface active
CursorMeta.NextCursor field v3 compatibility surface active
CursorQuery type v3 compatibility surface active
CursorQuery.Cursor field v3 compatibility surface active
CursorQuery.Limit field v3 compatibility surface active
CursorQuery.Raw field v3 compatibility surface active
CursorQuery.Values field v3 compatibility surface active
CursorQueryConfig type v3 compatibility surface active
CursorQueryConfig.Codec field v3 compatibility surface active
CursorQueryConfig.CursorParam field v3 compatibility surface active
CursorQueryConfig.DefaultLimit field v3 compatibility surface active
CursorQueryConfig.LimitParam field v3 compatibility surface active
CursorQueryConfig.MaxLimit field v3 compatibility surface active
CursorResponse type v3 compatibility surface active
CursorResponse.Data field v3 compatibility surface active
CursorResponse.Meta field v3 compatibility surface active
DefaultFilterParserChecked func v3 compatibility surface active
DefaultSortParserChecked func v3 compatibility surface active
Filters type v3 compatibility surface active
ListMeta type v3 compatibility surface active
ListMeta.Count field v3 compatibility surface active
ListMeta.Filters field v3 compatibility surface active
ListMeta.Limit field v3 compatibility surface active
ListMeta.Offset field v3 compatibility surface active
ListMeta.Search field v3 compatibility surface active
ListMeta.Sort field v3 compatibility surface active
ListMeta.Total field v3 compatibility surface active
ListQuery type v3 compatibility surface active
ListQuery.Filters field v3 compatibility surface active
ListQuery.First method v3 compatibility surface active
ListQuery.Has method v3 compatibility surface active
ListQuery.Limit field v3 compatibility surface active
ListQuery.MissingRequired method v3 compatibility surface active
ListQuery.Offset field v3 compatibility surface active
ListQuery.Raw field v3 compatibility surface active
ListQuery.Search field v3 compatibility surface active
ListQuery.Sort field v3 compatibility surface active
ListQueryConfig type v3 compatibility surface active
ListQueryConfig.AllowedFilters field v3 compatibility surface active
ListQueryConfig.AllowedSorts field v3 compatibility surface active
ListQueryConfig.DefaultLimit field v3 compatibility surface active
ListQueryConfig.DefaultSort field v3 compatibility surface active
ListQueryConfig.FilterParser field v3 compatibility surface active
ListQueryConfig.MaxLimit field v3 compatibility surface active
ListQueryConfig.Required field v3 compatibility surface active
ListQueryConfig.SearchParam field v3 compatibility surface active
ListQueryConfig.SortParam field v3 compatibility surface active
ListQueryConfig.SortParser field v3 compatibility surface active
ListResponse type v3 compatibility surface active
ListResponse.Data field v3 compatibility surface active
ListResponse.Meta field v3 compatibility surface active
NewCursorResponse func v3 compatibility surface active
NewHMACCursorCodec func v3 compatibility surface active
NewListResponse func v3 compatibility surface active
ParseCursorQueryChecked func v3 compatibility surface active
ParseListQueryChecked func v3 compatibility surface active
SortField type v3 compatibility surface active
SortField.Desc field v3 compatibility surface active
SortField.Field field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/endpoints/pprof

Stability tier: stable

Symbol Kind Added version Deprecation status
RegisterAdminRoutes func v3 compatibility surface active
RegisterRoutes func v3 compatibility surface deprecated
Router type v3 compatibility surface active
Router.Get interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/endpoints/version

Stability tier: stable

Symbol Kind Added version Deprecation status
Config type v3 compatibility surface active
Config.Info field v3 compatibility surface active
Config.Path field v3 compatibility surface active
Handler type v3 compatibility surface active
Handler.Handler method v3 compatibility surface active
Handler.RegisterRoutes method v3 compatibility surface active
Handler.RegisterRoutesTo method v3 compatibility surface active
Info type v3 compatibility surface active
Info.Commit field v3 compatibility surface active
Info.Date field v3 compatibility surface active
Info.Version field v3 compatibility surface active
NewHandler func v3 compatibility surface active
RouteRegistrar type v3 compatibility surface active
RouteRegistrar.Get interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/fielderrors

Stability tier: stable

Symbol Kind Added version Deprecation status
FieldError type v3 compatibility surface active
FieldError.Code field v3 compatibility surface active
FieldError.Error method v3 compatibility surface active
FieldError.Field field v3 compatibility surface active
FieldError.Message field v3 compatibility surface active
FieldError.Public field v3 compatibility surface active
FieldErrors type v3 compatibility surface active
FieldErrors.AllPublic method v3 compatibility surface active
FieldErrors.Error method v3 compatibility surface active
FieldErrors.FieldErrors method v3 compatibility surface active
FieldErrors.ToMap method v3 compatibility surface active
Provider type v3 compatibility surface active
Provider.FieldErrors interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/httpcache

Stability tier: stable

Symbol Kind Added version Deprecation status
Decision type v3 compatibility surface active
Decision.NotModified field v3 compatibility surface active
Decision.PreconditionFailed field v3 compatibility surface active
Decision.Status field v3 compatibility surface active
ETag type v3 compatibility surface active
ETag.IsWeak method v3 compatibility surface active
ETag.String method v3 compatibility surface active
EvaluateRead func v3 compatibility surface active
EvaluateWrite func v3 compatibility surface active
HashETag func v3 compatibility surface active
ParseETag func v3 compatibility surface active
SetValidators func v3 compatibility surface active
StrongETag func v3 compatibility surface active
Validators type v3 compatibility surface active
Validators.ETag field v3 compatibility surface active
Validators.LastModified field v3 compatibility surface active
WeakETag func v3 compatibility surface active
WriteNotModified func v3 compatibility surface active
WritePreconditionFailed func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/httpx

Stability tier: stable

Symbol Kind Added version Deprecation status
DefaultProblemCatalog func v3 compatibility surface active
DefaultTypeBase const v3 compatibility surface active
DefaultTypeForStatus func v3 compatibility surface active
DefaultTypeRegistry func v3 compatibility surface active
DefaultTypeURI func v3 compatibility surface active
ErrForbidden var v3 compatibility surface active
ErrHeaderBytesExceeded var v3 compatibility surface active
ErrHeaderCountExceeded var v3 compatibility surface active
ErrResourceMissing var v3 compatibility surface active
ErrTooManyRequests var v3 compatibility surface active
ErrUnauthorized var v3 compatibility surface active
ErrorMode type v3 compatibility surface active
ErrorModeDefault const v3 compatibility surface active
ErrorModeStrict const v3 compatibility surface active
ErrorOptions type v3 compatibility surface active
ErrorOptions.Mode field v3 compatibility surface active
ErrorOptions.TypeRegistry field v3 compatibility surface active
HTTPError type v3 compatibility surface active
HTTPError.Detail field v3 compatibility surface active
HTTPError.Err field v3 compatibility surface active
HTTPError.Error method v3 compatibility surface active
HTTPError.Status field v3 compatibility surface active
HTTPError.Title field v3 compatibility surface active
HTTPError.Type field v3 compatibility surface active
HTTPError.Unwrap method v3 compatibility surface active
HeaderBytes func v3 compatibility surface active
HeaderCount func v3 compatibility surface active
HeaderLimits type v3 compatibility surface active
HeaderLimits.ApplyServer method v3 compatibility surface active
HeaderLimits.Check method v3 compatibility surface active
HeaderLimits.MaxBytes field v3 compatibility surface active
HeaderLimits.MaxCount field v3 compatibility surface active
HeaderLimitsBalanced var v3 compatibility surface active
HeaderLimitsRelaxed var v3 compatibility surface active
HeaderLimitsStrict var v3 compatibility surface active
NewHTTPError func v3 compatibility surface active
NewProblemCatalog func v3 compatibility surface active
NewProblemError func v3 compatibility surface active
NewTypeRegistry func v3 compatibility surface active
Problem type v3 compatibility surface active
Problem.Detail field v3 compatibility surface active
Problem.Ext field v3 compatibility surface active
Problem.Instance field v3 compatibility surface active
Problem.Status field v3 compatibility surface active
Problem.Title field v3 compatibility surface active
Problem.Type field v3 compatibility surface active
Problem.With method v3 compatibility surface active
ProblemCatalog type v3 compatibility surface active
ProblemCatalog.Definition method v3 compatibility surface active
ProblemCatalog.Definitions method v3 compatibility surface active
ProblemCatalog.Problem method v3 compatibility surface active
ProblemCatalog.Register method v3 compatibility surface active
ProblemCode type v3 compatibility surface active
ProblemDefinition type v3 compatibility surface active
ProblemDefinition.Code field v3 compatibility surface active
ProblemDefinition.Detail field v3 compatibility surface active
ProblemDefinition.DocumentationURL field v3 compatibility surface active
ProblemDefinition.LogLevel field v3 compatibility surface active
ProblemDefinition.Retryable field v3 compatibility surface active
ProblemDefinition.Status field v3 compatibility surface active
ProblemDefinition.Title field v3 compatibility surface active
ProblemDefinition.Type field v3 compatibility surface active
ProblemError type v3 compatibility surface active
ProblemError.Code field v3 compatibility surface active
ProblemError.Detail field v3 compatibility surface active
ProblemError.Err field v3 compatibility surface active
ProblemError.Error method v3 compatibility surface active
ProblemError.Unwrap method v3 compatibility surface active
ProblemFromCode func v3 compatibility surface active
ProblemFromError func v3 compatibility surface active
ProblemFromErrorStrict func v3 compatibility surface active
ProblemFromErrorWithCatalog func v3 compatibility surface active
ProblemFromErrorWithOptions func v3 compatibility surface active
ResponseWriteError type v3 compatibility surface active
ResponseWriteError.Err field v3 compatibility surface active
ResponseWriteError.Error method v3 compatibility surface active
ResponseWriteError.Stage field v3 compatibility surface active
ResponseWriteError.Unwrap method v3 compatibility surface active
ResponseWriteStage type v3 compatibility surface active
ResponseWriteStageBody const v3 compatibility surface active
ResponseWriteStageEncode const v3 compatibility surface active
ResponseWriteStageHeader const v3 compatibility surface active
TypeBadRequest const v3 compatibility surface active
TypeConflict const v3 compatibility surface active
TypeForbidden const v3 compatibility surface active
TypeInternal const v3 compatibility surface active
TypeNotAcceptable const v3 compatibility surface active
TypeNotFound const v3 compatibility surface active
TypePayloadTooLarge const v3 compatibility surface active
TypeRateLimited const v3 compatibility surface active
TypeRegistry type v3 compatibility surface active
TypeRegistry.Register method v3 compatibility surface active
TypeRegistry.Types method v3 compatibility surface active
TypeRegistry.URI method v3 compatibility surface active
TypeServiceUnavailable const v3 compatibility surface active
TypeURI func v3 compatibility surface active
TypeUnauthorized const v3 compatibility surface active
TypeUnsupportedMedia const v3 compatibility surface active
TypeValidation const v3 compatibility surface active
ValidationErrors type v3 compatibility surface active
ValidationErrors.Fields field v3 compatibility surface active
ValidationErrorsKey const v3 compatibility surface active
WithFieldErrors func v3 compatibility surface active
WithValidationErrors func v3 compatibility surface active
WriteError func v3 compatibility surface active
WriteErrorStrict func v3 compatibility surface active
WriteErrorWithOptions func v3 compatibility surface active
WriteJSON func v3 compatibility surface active
WriteJSONChecked func v3 compatibility surface active
WriteProblem func v3 compatibility surface active
WriteProblemChecked func v3 compatibility surface active
WriteProblemCode func v3 compatibility surface active
WriteProblemWithFieldErrors func v3 compatibility surface active
WriteSimpleProblem func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/httpx/identity

Stability tier: stable

Symbol Kind Added version Deprecation status
ClientInfo type v3 compatibility surface active
ClientInfo.Host field v3 compatibility surface active
ClientInfo.IP field v3 compatibility surface active
ClientInfo.IPString field v3 compatibility surface active
ClientInfo.RequestID field v3 compatibility surface active
ClientInfo.Scheme field v3 compatibility surface active
HeaderPolicy type v3 compatibility surface active
HeaderPolicyBoth const v3 compatibility surface active
HeaderPolicyForwarded const v3 compatibility surface active
HeaderPolicyNone const v3 compatibility surface active
HeaderPolicyXForwarded const v3 compatibility surface active
ParseTrustedProxies func v3 compatibility surface active
RequestID func v3 compatibility surface active
Resolver type v3 compatibility surface active
Resolver.ClientIP method v3 compatibility surface active
Resolver.ClientIPString method v3 compatibility surface active
Resolver.HeaderPolicy field v3 compatibility surface active
Resolver.Host method v3 compatibility surface active
Resolver.Resolve method v3 compatibility surface active
Resolver.Scheme method v3 compatibility surface active
Resolver.TrustedProxies field v3 compatibility surface active
Resolver.TrustsRemoteAddr method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/httpx/recover

Stability tier: stable

Symbol Kind Added version Deprecation status
Middleware func v3 compatibility surface active
New func v3 compatibility surface active
Option type v3 compatibility surface active
WithLogger func v3 compatibility surface active
WithStackLogging func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/idempotent

Stability tier: stable

Symbol Kind Added version Deprecation status
AsyncConfig type v3 compatibility surface active
AsyncConfig.ID field v3 compatibility surface active
AsyncConfig.Location field v3 compatibility surface active
AsyncConfig.RetryAfter field v3 compatibility surface active
ConflictProblem func v3 compatibility surface active
CreateConfig type v3 compatibility surface active
CreateConfig.HeaderName field v3 compatibility surface active
CreateConfig.Required field v3 compatibility surface active
OperationExtensions func v3 compatibility surface active
ReplayProblem func v3 compatibility surface active
RequestHash func v3 compatibility surface active
RequireKey func v3 compatibility surface active
UpdateConfig type v3 compatibility surface active
UpdateConfig.HeaderName field v3 compatibility surface active
UpdateConfig.Required field v3 compatibility surface active
WriteAcceptedReplay func v3 compatibility surface active
WriteConflict func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/auth/apikey

Stability tier: stable

Symbol Kind Added version Deprecation status
Config type v3 compatibility surface active
Config.HeaderNames field v3 compatibility surface active
Config.Verifier field v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.OptionalHandler method v3 compatibility surface active
NewMiddleware func v3 compatibility surface active
PresentedKey type v3 compatibility surface active
PresentedKey.Source field v3 compatibility surface active
PresentedKey.Value field v3 compatibility surface active
Principal type v3 compatibility surface active
Principal.HasScope method v3 compatibility surface active
Principal.ID field v3 compatibility surface active
Principal.Metadata field v3 compatibility surface active
Principal.Name field v3 compatibility surface active
Principal.Scopes field v3 compatibility surface active
Principal.TenantID field v3 compatibility surface active
PrincipalFromContext func v3 compatibility surface active
RequireScopeMiddleware func v3 compatibility surface active
Verifier type v3 compatibility surface active
Verifier.VerifyAPIKey interface method v3 compatibility surface active
VerifierFunc type v3 compatibility surface active
VerifierFunc.VerifyAPIKey method v3 compatibility surface active
WithPrincipal func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/auth/authz

Stability tier: stable

Symbol Kind Added version Deprecation status
ErrRequireRoleMissingResolver var v3 compatibility surface active
ErrRequireRoleMissingRole var v3 compatibility surface active
NewRequireRoleMiddleware func v3 compatibility surface active
NewRequireRoleMiddlewareChecked func v3 compatibility surface active
RequireRoleMiddleware type v3 compatibility surface active
RequireRoleMiddleware.Handler method v3 compatibility surface active
RequireRoleRouteSpec type v3 compatibility surface active
RequireRoleRouteSpec.Method field v3 compatibility surface active
RequireRoleRouteSpec.Middleware field v3 compatibility surface active
RequireRoleRouteSpec.Route field v3 compatibility surface active
RolesFromContext type v3 compatibility surface active
ValidateRequireRoleMiddleware func v3 compatibility surface active
ValidateRequireRoleMiddlewareRoutes func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/auth/tenant

Stability tier: stable

Symbol Kind Added version Deprecation status
ErrorHandler type v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.ErrorHandler field v3 compatibility surface active
Options.HeaderName field v3 compatibility surface active
Options.Optional field v3 compatibility surface active
Options.RequireAllSources field v3 compatibility surface active
Options.TenantFromContext field v3 compatibility surface active
Options.URLParam field v3 compatibility surface active
Options.URLParamExtractor field v3 compatibility surface active
TenantFromContext type v3 compatibility surface active
URLParamExtractor type v3 compatibility surface active
URLParamExtractor.URLParam interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/deprecation

Stability tier: stable

Symbol Kind Added version Deprecation status
Config type v3 compatibility surface active
Config.DeprecatedAt field v3 compatibility surface active
Config.Disabled field v3 compatibility surface active
Config.Links field v3 compatibility surface active
Config.SunsetAt field v3 compatibility surface active
Handler func v3 compatibility surface active
Link type v3 compatibility surface active
Link.Rel field v3 compatibility surface active
Link.Title field v3 compatibility surface active
Link.Type field v3 compatibility surface active
Link.URL field v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
New func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/idempotency

Stability tier: stable

Symbol Kind Added version Deprecation status
DefaultHash func v3 compatibility surface active
ErrLegacyInFlightClockSkewPreflightRisk var v3 compatibility surface active
ErrLegacyInFlightReservationMissingToken var v3 compatibility surface active
ErrLegacyInFlightTTLMismatch var v3 compatibility surface active
ErrLegacyInFlightTokenMismatch var v3 compatibility surface active
HashFunc type v3 compatibility surface active
IdempotencyOutcomeAmbiguous const v3 compatibility surface active
IdempotencyOutcomeCompletedReleased const v3 compatibility surface active
IdempotencyOutcomeCompletedStored const v3 compatibility surface active
IdempotencyOutcomeConflict const v3 compatibility surface active
IdempotencyOutcomeFailOpen const v3 compatibility surface active
IdempotencyOutcomeInFlight const v3 compatibility surface active
IdempotencyOutcomeInvalidRequest const v3 compatibility surface active
IdempotencyOutcomeLookupFailed const v3 compatibility surface active
IdempotencyOutcomeMissingKey const v3 compatibility surface active
IdempotencyOutcomePersistenceFailed const v3 compatibility surface active
IdempotencyOutcomeReplayed const v3 compatibility surface active
IdempotencyOutcomeReservationFailed const v3 compatibility surface active
IdempotencyOutcomeReservationUnavailable const v3 compatibility surface active
IdempotencyOutcomeResponseTooLarge const v3 compatibility surface active
KeyFunc type v3 compatibility surface active
LegacyInFlightCompatibilityEntered const v3 compatibility surface active
LegacyInFlightCompatibilityEvent type v3 compatibility surface active
LegacyInFlightCompatibilityEvent.Error field v3 compatibility surface active
LegacyInFlightCompatibilityEvent.Key field v3 compatibility surface active
LegacyInFlightCompatibilityEvent.Method field v3 compatibility surface active
LegacyInFlightCompatibilityEvent.MetricLabels method v3 compatibility surface active
LegacyInFlightCompatibilityEvent.Outcome field v3 compatibility surface active
LegacyInFlightCompatibilityEvent.Path field v3 compatibility surface active
LegacyInFlightCompatibilityEvent.StoreType field v3 compatibility surface active
LegacyInFlightCompatibilityEventName type v3 compatibility surface active
LegacyInFlightCompatibilityEventSink type v3 compatibility surface active
LegacyInFlightCompatibilityEventSink.Emit interface method v3 compatibility surface active
LegacyInFlightCompatibilityHandler type v3 compatibility surface active
LegacyInFlightCompatibilityMetricLabels type v3 compatibility surface active
LegacyInFlightCompatibilityMetricSink type v3 compatibility surface active
LegacyInFlightCompatibilityMetricSink.Emit interface method v3 compatibility surface active
LegacyInFlightCompatibilityMetricSinkFunc type v3 compatibility surface active
LegacyInFlightCompatibilityMetricSinkFunc.Emit method v3 compatibility surface active
LegacyInFlightCompatibilityRecovered const v3 compatibility surface active
LegacyInFlightCompatibilityRejected const v3 compatibility surface active
LegacyInFlightCompatibilitySinkFunc type v3 compatibility surface active
LegacyInFlightCompatibilitySinkFunc.Emit method v3 compatibility surface active
LegacyInFlightCompatibilityUnknown const v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.Clock field v3 compatibility surface active
Options.FailOnInFlightClockSkewPreflight field v3 compatibility surface active
Options.FailOnInFlightTTLMismatch field v3 compatibility surface active
Options.FailOpen field v3 compatibility surface active
Options.HashFunc field v3 compatibility surface active
Options.HeaderName field v3 compatibility surface active
Options.InFlightTTL field v3 compatibility surface active
Options.KeyFunc field v3 compatibility surface active
Options.KnownInFlightTTLs field v3 compatibility surface active
Options.LegacyInFlightCompatibilityAsync field v3 compatibility surface active
Options.LegacyInFlightCompatibilityMetricSink field v3 compatibility surface active
Options.LegacyInFlightCompatibilityRawKey field v3 compatibility surface active
Options.LegacyInFlightCompatibilitySampleEvery field v3 compatibility surface active
Options.LegacyInFlightCompatibilitySink field v3 compatibility surface active
Options.Logger field v3 compatibility surface active
Options.MaxBodyBytes field v3 compatibility surface active
Options.MaxResponseBytes field v3 compatibility surface active
Options.OnError field v3 compatibility surface active
Options.OnLegacyInFlightCompatibility field v3 compatibility surface active
Options.OnOutcome field v3 compatibility surface active
Options.ReplayHeaderName field v3 compatibility surface active
Options.RequireKey field v3 compatibility surface active
Options.ResponseHeaderAllow field v3 compatibility surface active
Options.ResponseHeaderDeny field v3 compatibility surface active
Options.ShouldHandle field v3 compatibility surface active
Options.ShouldStore field v3 compatibility surface active
Options.StorageKeyFunc field v3 compatibility surface active
Options.Store field v3 compatibility surface active
Options.TTL field v3 compatibility surface active
OutcomeEvent type v3 compatibility surface active
OutcomeEvent.FailOpen field v3 compatibility surface active
OutcomeEvent.Method field v3 compatibility surface active
OutcomeEvent.MetricLabels method v3 compatibility surface active
OutcomeEvent.Outcome field v3 compatibility surface active
OutcomeEvent.Status field v3 compatibility surface active
OutcomeEvent.StoreType field v3 compatibility surface active
OutcomeEventName type v3 compatibility surface active
OutcomeHandler type v3 compatibility surface active
Record type v3 compatibility surface active
Record.Body field v3 compatibility surface active
Record.CreatedAt field v3 compatibility surface active
Record.Header field v3 compatibility surface active
Record.RequestHash field v3 compatibility surface active
Record.ReservationToken field v3 compatibility surface active
Record.State field v3 compatibility surface active
Record.Status field v3 compatibility surface active
ReleasableStore type v3 compatibility surface active
ReleasableStore.ReservationReleaser interface method v3 compatibility surface active
ReleasableStore.Store interface method v3 compatibility surface active
ReservationReleaser type v3 compatibility surface active
ReservationReleaser.ReleaseReservation interface method v3 compatibility surface active
State type v3 compatibility surface active
StateAmbiguous const v3 compatibility surface active
StateCompleted const v3 compatibility surface active
StateInFlight const v3 compatibility surface active
StateUnknown const v3 compatibility surface active
StorageKeyFunc type v3 compatibility surface active
Store type v3 compatibility surface active
Store.Get interface method v3 compatibility surface active
Store.Save interface method v3 compatibility surface active
Store.TryBegin interface method v3 compatibility surface active
TenantScopedStorageKeyFunc func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/json

Stability tier: stable

Symbol Kind Added version Deprecation status
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
Middleware.RequireJSON field v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.RequireJSON field v3 compatibility surface active
StrictDecoder func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/maxbody

Stability tier: stable

Symbol Kind Added version Deprecation status
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.MaxBytes field v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.MaxBytes field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/querylimits

Stability tier: stable

Symbol Kind Added version Deprecation status
ErrorWriter type v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.ErrorWriter field v3 compatibility surface active
Options.LimitParam field v3 compatibility surface active
Options.MaxKeyLength field v3 compatibility surface active
Options.MaxLimit field v3 compatibility surface active
Options.MaxParams field v3 compatibility surface active
Options.MaxValueLength field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/ratelimit

Stability tier: stable

Symbol Kind Added version Deprecation status
Decision type v3 compatibility surface active
Decision.Allowed field v3 compatibility surface active
Decision.Limit field v3 compatibility surface active
Decision.Quota field v3 compatibility surface active
Decision.Remaining field v3 compatibility surface active
Decision.Reset field v3 compatibility surface active
Decision.RetryAfter field v3 compatibility surface active
DecisionLimiter type v3 compatibility surface active
DecisionLimiter.Allow interface method v3 compatibility surface active
DefaultHeaderConfig func v3 compatibility surface active
HeaderConfig type v3 compatibility surface active
HeaderConfig.Enabled field v3 compatibility surface active
HeaderConfig.LimitHeader field v3 compatibility surface active
HeaderConfig.RemainingHeader field v3 compatibility surface active
HeaderConfig.ResetHeader field v3 compatibility surface active
HeaderConfig.RetryAfterHeader field v3 compatibility surface active
KeyFn type v3 compatibility surface active
Limiter type v3 compatibility surface active
Limiter.Allow interface method v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.AllowDangerousDevBypasses field v3 compatibility surface active
Options.Capacity field v3 compatibility surface active
Options.CleanupInterval field v3 compatibility surface active
Options.ClientIPResolver field v3 compatibility surface active
Options.Clock field v3 compatibility surface active
Options.DecisionLimiter field v3 compatibility surface active
Options.FailOpen field v3 compatibility surface active
Options.HeaderConfig field v3 compatibility surface active
Options.Key field v3 compatibility surface active
Options.Limiter field v3 compatibility surface active
Options.OnError field v3 compatibility surface active
Options.RefillRate field v3 compatibility surface active
Options.RetryAfter field v3 compatibility surface active
Options.SkipEnabled field v3 compatibility surface active
Options.SkipHeader field v3 compatibility surface active
Options.StateTTL field v3 compatibility surface active
Quota type v3 compatibility surface active
Quota.Limit field v3 compatibility surface active
Quota.Remaining field v3 compatibility surface active
Quota.Reset field v3 compatibility surface active
Quota.RetryAfter field v3 compatibility surface active
QuotaFromDecision func v3 compatibility surface active
SetRateLimitHeaders func v3 compatibility surface active
WriteRateLimited func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/secure

Stability tier: stable

Symbol Kind Added version Deprecation status
APIOnly func v3 compatibility surface active
CSPPolicy func v3 compatibility surface active
CSPProfile type v3 compatibility surface active
CSPProfileAPI const v3 compatibility surface active
CSPProfileAPIDocs const v3 compatibility surface active
CSPProfileWebApp const v3 compatibility surface active
CSPTemplate type v3 compatibility surface active
CSPTemplateValues type v3 compatibility surface active
CSPTemplateValues.ConnectSrc field v3 compatibility surface active
CSPTemplateValues.FontSrc field v3 compatibility surface active
CSPTemplateValues.ImgSrc field v3 compatibility surface active
CSPTemplateValues.Nonce field v3 compatibility surface active
CSPTemplateValues.ScriptSrc field v3 compatibility surface active
CSPTemplateValues.StyleSrc field v3 compatibility surface active
CSPTemplateWebApp const v3 compatibility surface active
DocsUI func v3 compatibility surface active
Handler type v3 compatibility surface active
Handler.Middleware method v3 compatibility surface active
HeaderProfile type v3 compatibility surface active
HeaderProfileAPIOnly const v3 compatibility surface active
HeaderProfileDocsUI const v3 compatibility surface active
HeaderProfileWebApp const v3 compatibility surface active
New func v3 compatibility surface active
Option type v3 compatibility surface active
Options type v3 compatibility surface active
Options.ContentSecurityPolicy field v3 compatibility surface active
Options.ContentSecurityPolicyFunc field v3 compatibility surface active
Options.ContentTypeOptions field v3 compatibility surface active
Options.CrossOriginEmbedderPolicy field v3 compatibility surface active
Options.CrossOriginOpenerPolicy field v3 compatibility surface active
Options.CrossOriginResourcePolicy field v3 compatibility surface active
Options.FrameOptions field v3 compatibility surface active
Options.HSTSIncludeSubdomains field v3 compatibility surface active
Options.HSTSMaxAge field v3 compatibility surface active
Options.HSTSPreload field v3 compatibility surface active
Options.PermissionsPolicy field v3 compatibility surface active
Options.ReferrerPolicy field v3 compatibility surface active
Options.Resolver field v3 compatibility surface active
RenderCSPTemplate func v3 compatibility surface active
WebApp func v3 compatibility surface active
WithCOEP func v3 compatibility surface active
WithCOOP func v3 compatibility surface active
WithCORP func v3 compatibility surface active
WithCSP func v3 compatibility surface active
WithCSPFunc func v3 compatibility surface active
WithCSPProfile func v3 compatibility surface active
WithCSPTemplate func v3 compatibility surface active
WithCSPTemplateFunc func v3 compatibility surface active
WithCrossOriginIsolation func v3 compatibility surface active
WithCrossOriginPolicies func v3 compatibility surface active
WithHSTS func v3 compatibility surface active
WithHeaderProfile func v3 compatibility surface active
WithPermissionsPolicy func v3 compatibility surface active
WithResolver func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/timeout

Stability tier: stable

Symbol Kind Added version Deprecation status
ErrHardTimeoutCaptureLimitExceeded var v3 compatibility surface active
HardTimeout type v3 compatibility surface active
HardTimeout.EventHooks field v3 compatibility surface active
HardTimeout.Handler method v3 compatibility surface active
HardTimeout.MaxCaptureBytes field v3 compatibility surface active
HardTimeout.Middleware method v3 compatibility surface deprecated
HardTimeout.Timeout field v3 compatibility surface active
HardTimeout.WrapRoute method v3 compatibility surface active
HardTimeoutEvent type v3 compatibility surface active
HardTimeoutEvent.CaptureLimit field v3 compatibility surface active
HardTimeoutEvent.CaptureOverflow field v3 compatibility surface active
HardTimeoutEvent.Duration field v3 compatibility surface active
HardTimeoutEvent.Method field v3 compatibility surface active
HardTimeoutEvent.Outcome field v3 compatibility surface active
HardTimeoutEvent.Panicked field v3 compatibility surface active
HardTimeoutEvent.Status field v3 compatibility surface active
HardTimeoutEvent.TimedOut field v3 compatibility surface active
HardTimeoutEvent.Timeout field v3 compatibility surface active
HardTimeoutEventHooks type v3 compatibility surface active
HardTimeoutEventHooks.OnEvent field v3 compatibility surface active
HardTimeoutEventHooks.OnHandlerContinuesAfterTimeout field v3 compatibility surface active
HardTimeoutOutcome type v3 compatibility surface active
HardTimeoutOutcomeCaptureOverflow const v3 compatibility surface active
HardTimeoutOutcomePanic const v3 compatibility surface active
HardTimeoutOutcomeTimeout const v3 compatibility surface active
Middleware type v3 compatibility surface active
New func v3 compatibility surface deprecated
NewHard func v3 compatibility surface active
NewPropagator func v3 compatibility surface active
Options type v3 compatibility surface active
Options.EventHooks field v3 compatibility surface active
Options.MaxCaptureBytes field v3 compatibility surface active
Options.Timeout field v3 compatibility surface active
Propagator type v3 compatibility surface active
Propagator.Handler method v3 compatibility surface active
Propagator.Middleware method v3 compatibility surface active
Propagator.Timeout field v3 compatibility surface active
RouteCapabilities type v3 compatibility surface active
RouteCapabilities.Flusher field v3 compatibility surface active
RouteCapabilities.Hijacker field v3 compatibility surface active
RouteCapabilities.LargeDownload field v3 compatibility surface active
RouteCapabilities.Pusher field v3 compatibility surface active
RouteCapabilities.ReaderFrom field v3 compatibility surface active
RouteCapabilities.ServerSentEvents field v3 compatibility surface active
RouteCapabilities.Streaming field v3 compatibility surface active
RouteCapabilities.ValidateHardTimeout method v3 compatibility surface active
RouteCapabilities.WebSocketUpgrade field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/middleware/trace

Stability tier: stable

Symbol Kind Added version Deprecation status
GetSpanID func v3 compatibility surface active
GetTraceID func v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
New func v3 compatibility surface active
Options type v3 compatibility surface active
Options.SampledFlag field v3 compatibility surface active
Options.SpanIDGen field v3 compatibility surface active
Options.TraceIDGen field v3 compatibility surface active
Options.TrustIncoming field v3 compatibility surface active
Use func v3 compatibility surface deprecated

github.com/aatuh/api-toolkit/v4/negotiation

Stability tier: stable

Symbol Kind Added version Deprecation status
Accept type v3 compatibility surface active
Accept.MediaType field v3 compatibility surface active
Accept.Order field v3 compatibility surface active
Accept.Params field v3 compatibility surface active
Accept.Q field v3 compatibility surface active
Accept.Subtype field v3 compatibility surface active
Accept.Type field v3 compatibility surface active
Config type v3 compatibility surface active
Config.Accept field v3 compatibility surface active
Config.ContentTypes field v3 compatibility surface active
ContentTypeAllowed func v3 compatibility surface active
MediaType type v3 compatibility surface active
Middleware type v3 compatibility surface active
Middleware.Handler method v3 compatibility surface active
Middleware.Middleware method v3 compatibility surface active
Negotiate func v3 compatibility surface active
New func v3 compatibility surface active
ParseAccept func v3 compatibility surface active
RequireAccept func v3 compatibility surface active
RequireContentType func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/operations

Stability tier: stable

Symbol Kind Added version Deprecation status
Accepted type v3 compatibility surface active
Accepted.ID field v3 compatibility surface active
Accepted.Location field v3 compatibility surface active
Accepted.State field v3 compatibility surface active
AcceptedConfig type v3 compatibility surface active
AcceptedConfig.ID field v3 compatibility surface active
AcceptedConfig.Location field v3 compatibility surface active
AcceptedConfig.RetryAfter field v3 compatibility surface active
CanTransition func v3 compatibility surface active
ErrInvalidState var v3 compatibility surface active
ErrInvalidTransition var v3 compatibility surface active
IsTerminal func v3 compatibility surface active
Operation type v3 compatibility surface active
Operation.ID field v3 compatibility surface active
Operation.Problem field v3 compatibility surface active
Operation.Result field v3 compatibility surface active
Operation.State field v3 compatibility surface active
PollConfig type v3 compatibility surface active
PollConfig.ErrorWriter field v3 compatibility surface active
PollConfig.OperationID field v3 compatibility surface active
PollConfig.Store field v3 compatibility surface active
PollHandler func v3 compatibility surface active
Repository type v3 compatibility surface active
Repository.Store interface method v3 compatibility surface active
Repository.Writer interface method v3 compatibility surface active
State type v3 compatibility surface active
StateCanceled const v3 compatibility surface active
StateFailed const v3 compatibility surface active
StatePending const v3 compatibility surface active
StateRunning const v3 compatibility surface active
StateSucceeded const v3 compatibility surface active
Store type v3 compatibility surface active
Store.GetOperation interface method v3 compatibility surface active
StoreFunc type v3 compatibility surface active
StoreFunc.GetOperation method v3 compatibility surface active
TransitionConfig type v3 compatibility surface active
TransitionConfig.Problem field v3 compatibility surface active
TransitionConfig.Result field v3 compatibility surface active
TransitionConfig.To field v3 compatibility surface active
TransitionOperation func v3 compatibility surface active
ValidateState func v3 compatibility surface active
WriteAccepted func v3 compatibility surface active
WriteOperation func v3 compatibility surface active
Writer type v3 compatibility surface active
Writer.CreateOperation interface method v3 compatibility surface active
Writer.UpdateOperation interface method v3 compatibility surface active
WriterFuncs type v3 compatibility surface active
WriterFuncs.Create field v3 compatibility surface active
WriterFuncs.CreateOperation method v3 compatibility surface active
WriterFuncs.Update field v3 compatibility surface active
WriterFuncs.UpdateOperation method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/ports

Stability tier: stable

Symbol Kind Added version Deprecation status
Clock type v3 compatibility surface active
Clock.Now interface method v3 compatibility surface active
IDGen type v3 compatibility surface active
IDGen.New interface method v3 compatibility surface active
Logger type v3 compatibility surface active
Logger.Debug interface method v3 compatibility surface active
Logger.Error interface method v3 compatibility surface active
Logger.Info interface method v3 compatibility surface active
Logger.Warn interface method v3 compatibility surface active
NopLogger type v3 compatibility surface active
NopLogger.Debug method v3 compatibility surface active
NopLogger.Error method v3 compatibility surface active
NopLogger.Info method v3 compatibility surface active
NopLogger.Warn method v3 compatibility surface active
SystemClock type v3 compatibility surface active
SystemClock.Now method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/queryparams

Stability tier: stable

Symbol Kind Added version Deprecation status
FieldSet type v3 compatibility surface active
FieldSet.ByResource field v3 compatibility surface active
FieldSet.Fields field v3 compatibility surface active
Filter type v3 compatibility surface active
Filter.Field field v3 compatibility surface active
Filter.Operator field v3 compatibility surface active
Filter.Values field v3 compatibility surface active
FilterConfig type v3 compatibility surface active
FilterConfig.Fields field v3 compatibility surface active
FilterField type v3 compatibility surface active
FilterField.Name field v3 compatibility surface active
FilterField.Operators field v3 compatibility surface active
FilterOperator type v3 compatibility surface active
FilterOperatorContains const v3 compatibility surface active
FilterOperatorEqual const v3 compatibility surface active
FilterOperatorGreaterThan const v3 compatibility surface active
FilterOperatorGreaterThanOrEqual const v3 compatibility surface active
FilterOperatorIn const v3 compatibility surface active
FilterOperatorLessThan const v3 compatibility surface active
FilterOperatorLessThanOrEqual const v3 compatibility surface active
FilterOperatorNotEqual const v3 compatibility surface active
IncludeSet type v3 compatibility surface active
IncludeSet.Includes field v3 compatibility surface active
ParseFields func v3 compatibility surface active
ParseFieldsChecked func v3 compatibility surface active
ParseFilters func v3 compatibility surface active
ParseFiltersChecked func v3 compatibility surface active
ParseIncludes func v3 compatibility surface active
ParseIncludesChecked func v3 compatibility surface active
ParseSort func v3 compatibility surface active
ParseSortChecked func v3 compatibility surface active
Sort type v3 compatibility surface active
Sort.Fields field v3 compatibility surface active
SortConfig type v3 compatibility surface active
SortConfig.AllowedFields field v3 compatibility surface active
SortField type v3 compatibility surface active
SortField.Desc field v3 compatibility surface active
SortField.Name field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/routecontracts

Stability tier: stable

Symbol Kind Added version Deprecation status
CoverageError type v3 compatibility surface active
CoverageError.Error method v3 compatibility surface active
CoverageError.Problems field v3 compatibility surface active
NewRegistry func v3 compatibility surface active
NewRegistryWithOptions func v3 compatibility surface active
Options type v3 compatibility surface active
Options.Policies field v3 compatibility surface active
Policy type v3 compatibility surface active
Policy.Apply interface method v3 compatibility surface active
PolicyFunc type v3 compatibility surface active
PolicyFunc.Apply method v3 compatibility surface active
Registry type v3 compatibility surface active
Registry.Delete method v3 compatibility surface active
Registry.Get method v3 compatibility surface active
Registry.Patch method v3 compatibility surface active
Registry.Post method v3 compatibility surface active
Registry.Put method v3 compatibility surface active
Registry.Register method v3 compatibility surface active
Registry.Routes method v3 compatibility surface active
Registry.Validate method v3 compatibility surface active
Route type v3 compatibility surface active
Route.Handler field v3 compatibility surface active
Route.Method field v3 compatibility surface active
Route.Middleware field v3 compatibility surface active
Route.Operation field v3 compatibility surface active
Route.Pattern field v3 compatibility surface active
Router type v3 compatibility surface active
Router.Delete interface method v3 compatibility surface active
Router.Get interface method v3 compatibility surface active
Router.Post interface method v3 compatibility surface active
Router.Put interface method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/routepolicy

Stability tier: stable

Symbol Kind Added version Deprecation status
AdminPolicyFromOperation func v3 compatibility surface active
ApplyMetadata func v3 compatibility surface active
AuthPolicy type v3 compatibility surface active
AuthPolicy.Scopes field v3 compatibility surface active
AuthPolicy.Security field v3 compatibility surface active
AuthPolicyFromOperation func v3 compatibility surface active
AuthPolicyFunc type v3 compatibility surface active
Config type v3 compatibility surface active
Config.Auth field v3 compatibility surface active
Config.EmitPolicyExtension field v3 compatibility surface active
Config.EnableDeprecation field v3 compatibility surface active
Config.EnableNegotiation field v3 compatibility surface active
Config.Idempotency field v3 compatibility surface active
Config.ProblemCatalog field v3 compatibility surface active
Config.RateLimit field v3 compatibility surface active
DeprecationPolicy type v3 compatibility surface active
DeprecationPolicy.Deprecated field v3 compatibility surface active
DeprecationPolicy.Sunset field v3 compatibility surface active
DeprecationPolicyFromOperation func v3 compatibility surface active
ErrUnsupportedPolicy var v3 compatibility surface active
ExtensionAdminPolicy const v3 compatibility surface active
ExtensionIdempotencyKey const v3 compatibility surface active
ExtensionRateLimit const v3 compatibility surface active
ExtensionTenant const v3 compatibility surface active
IdempotencyPolicy type v3 compatibility surface active
IdempotencyPolicy.Header field v3 compatibility surface active
IdempotencyPolicy.Required field v3 compatibility surface active
IdempotencyPolicyFromOperation func v3 compatibility surface active
IdempotencyPolicyFunc type v3 compatibility surface active
LintFinding type v3 compatibility surface active
LintFinding.Code field v3 compatibility surface active
LintFinding.Error method v3 compatibility surface active
LintFinding.Message field v3 compatibility surface active
LintFinding.Method field v3 compatibility surface active
LintFinding.Path field v3 compatibility surface active
LintOperations func v3 compatibility surface active
LintOptions type v3 compatibility surface active
LintOptions.AdminPaths field v3 compatibility surface active
LintOptions.PublicPaths field v3 compatibility surface active
LintOptions.RequireOperationID field v3 compatibility surface active
LintOptions.RequireProblemResponse field v3 compatibility surface active
LintOptions.RequireSecurity field v3 compatibility surface active
LintOptions.RequireUniqueOperationID field v3 compatibility surface active
LintOptions.RequireUnsafeWriteAuth field v3 compatibility surface active
LintOptions.RequireUnsafeWriteIdempotency field v3 compatibility surface active
LintOptions.RequireUnsafeWriteProblemResponse field v3 compatibility surface active
LintOptions.RequireUnsafeWriteRateLimit field v3 compatibility surface active
LintOptions.RequireUnsafeWriteRequestBody field v3 compatibility surface active
LintOptions.RequireUnsafeWriteSuccessResponse field v3 compatibility surface active
LintOptions.RequireUnsafeWriteTenant field v3 compatibility surface active
MetadataOption type v3 compatibility surface active
New func v3 compatibility surface active
ObservabilityLabels type v3 compatibility surface active
ObservabilityLabels.Admin field v3 compatibility surface active
ObservabilityLabels.Auth field v3 compatibility surface active
ObservabilityLabels.Deprecated field v3 compatibility surface active
ObservabilityLabels.Idempotency field v3 compatibility surface active
ObservabilityLabels.Map method v3 compatibility surface active
ObservabilityLabels.RateLimit field v3 compatibility surface active
ObservabilityLabels.Tenant field v3 compatibility surface active
ObservabilityLabelsFromOperation func v3 compatibility surface active
ObservabilityLabelsFromRequest func v3 compatibility surface active
ObservabilityMiddleware func v3 compatibility surface active
Policy type v3 compatibility surface active
Policy.Apply method v3 compatibility surface active
ProblemCatalogPolicy type v3 compatibility surface active
ProblemResponseStatuses func v3 compatibility surface active
RateLimitPolicyFromOperation func v3 compatibility surface active
RateLimitPolicyFunc type v3 compatibility surface active
SeedObservabilityContext func v3 compatibility surface active
TenantPolicy type v3 compatibility surface active
TenantPolicy.Required field v3 compatibility surface active
TenantPolicy.Source field v3 compatibility surface active
TenantPolicyFromOperation func v3 compatibility surface active
WithAdminPolicy func v3 compatibility surface active
WithAuth func v3 compatibility surface active
WithDeprecated func v3 compatibility surface active
WithIdempotencyRequired func v3 compatibility surface active
WithOperationID func v3 compatibility surface active
WithProblemResponses func v3 compatibility surface active
WithRateLimit func v3 compatibility surface active
WithSunset func v3 compatibility surface active
WithTenantRequired func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/scheduler

Stability tier: stable

Symbol Kind Added version Deprecation status
Job type v3 compatibility surface active
Job.Interval field v3 compatibility surface active
Job.Name field v3 compatibility surface active
Job.Run field v3 compatibility surface active
LastRunProvider type v3 compatibility surface active
LastRunProvider.LastFinished interface method v3 compatibility surface active
Logger type v3 compatibility surface active
Logger.Error interface method v3 compatibility surface active
Logger.Info interface method v3 compatibility surface active
New func v3 compatibility surface active
Recorder type v3 compatibility surface active
Recorder.Record interface method v3 compatibility surface active
RecorderFailure type v3 compatibility surface active
RecorderFailure.Err field v3 compatibility surface active
RecorderFailure.ErrMsg field v3 compatibility surface active
RecorderFailure.FinishedAt field v3 compatibility surface active
RecorderFailure.JobName field v3 compatibility surface active
RecorderFailure.StartedAt field v3 compatibility surface active
RecorderFailure.Success field v3 compatibility surface active
RecorderFailureHandler type v3 compatibility surface active
RecorderFailureHandler.OnRecorderFailure interface method v3 compatibility surface active
RecorderFailureHandlerFunc type v3 compatibility surface active
RecorderFailureHandlerFunc.OnRecorderFailure method v3 compatibility surface active
RecorderFunc type v3 compatibility surface active
RecorderFunc.Record method v3 compatibility surface active
Runner type v3 compatibility surface active
Runner.SetRecorderFailureHandler method v3 compatibility surface active
Runner.Start method v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/scheduler/migrations

Stability tier: compatibility-only

Symbol Kind Added version Deprecation status
Migrations var v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/securityprofile

Stability tier: stable

Symbol Kind Added version Deprecation status
ErrorWriter type v3 compatibility surface active
MiddlewareChain type v3 compatibility surface active
MiddlewareChain.Use interface method v3 compatibility surface active
New func v3 compatibility surface active
OWASPBaseline func v3 compatibility surface active
Option type v3 compatibility surface active
Profile type v3 compatibility surface active
Profile.Apply method v3 compatibility surface active
Profile.ApplyTo method v3 compatibility surface active
Profile.Middlewares field v3 compatibility surface active
RouteOverride type v3 compatibility surface active
RouteOverride.HardTimeout field v3 compatibility surface active
RouteOverride.HardTimeoutMaxCaptureBytes field v3 compatibility surface active
RouteOverride.MaxBodyBytes field v3 compatibility surface active
RouteOverride.Methods field v3 compatibility surface active
RouteOverride.Pattern field v3 compatibility surface active
RouteOverride.QueryLimits field v3 compatibility surface active
RouteOverride.QueryLimitsEnabled field v3 compatibility surface active
RouteOverride.RateLimit field v3 compatibility surface active
RouteOverride.RateLimitEnabled field v3 compatibility surface active
RouteOverride.Timeout field v3 compatibility surface active
RouteOverride.TimeoutEnabled field v3 compatibility surface active
StreamingRouteOverride func v3 compatibility surface active
WithAuthAllowlist func v3 compatibility surface active
WithAuthCheck func v3 compatibility surface active
WithDevBypassHeader func v3 compatibility surface active
WithErrorWriter func v3 compatibility surface active
WithHardTimeout func v3 compatibility surface deprecated
WithHardTimeoutMaxCaptureBytes func v3 compatibility surface active
WithMaxBodyBytes func v3 compatibility surface active
WithQueryLimits func v3 compatibility surface active
WithQueryLimitsDisabled func v3 compatibility surface active
WithRateLimitDisabled func v3 compatibility surface active
WithRateLimitOptions func v3 compatibility surface active
WithRequireAuth func v3 compatibility surface active
WithResolver func v3 compatibility surface active
WithRouteOverrides func v3 compatibility surface active
WithSecureOptions func v3 compatibility surface active
WithTimeout func v3 compatibility surface active
WithTimeoutDisabled func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/specs

Stability tier: stable

Symbol Kind Added version Deprecation status
AllEndpoints var v3 compatibility surface active
Components type v3 compatibility surface active
Components.Responses field v3 compatibility surface active
Components.Schemas field v3 compatibility surface active
Components.SecuritySchemes field v3 compatibility surface active
Docs const v3 compatibility surface active
DocsEndpoints var v3 compatibility surface active
DocsInfo const v3 compatibility surface active
DocsOpenAPI const v3 compatibility surface active
DocsVersion const v3 compatibility surface active
DocumentationInfo type v3 compatibility surface active
DocumentationInfo.Contact field v3 compatibility surface active
DocumentationInfo.Description field v3 compatibility surface active
DocumentationInfo.License field v3 compatibility surface active
DocumentationInfo.Title field v3 compatibility surface active
DocumentationInfo.Version field v3 compatibility surface active
Example type v3 compatibility surface active
Example.Description field v3 compatibility surface active
Example.ExternalValue field v3 compatibility surface active
Example.Summary field v3 compatibility surface active
Example.Value field v3 compatibility surface active
HTTPProblemResponseName func v3 compatibility surface active
HTTPProblemResponseRef func v3 compatibility surface active
Health const v3 compatibility surface active
HealthDetailed const v3 compatibility surface active
HealthEndpoints var v3 compatibility surface active
Healthz const v3 compatibility surface active
Info type v3 compatibility surface active
Info.Description field v3 compatibility surface active
Info.Title field v3 compatibility surface active
Info.Version field v3 compatibility surface active
Livez const v3 compatibility surface active
MediaType type v3 compatibility surface active
MediaType.Example field v3 compatibility surface active
MediaType.Examples field v3 compatibility surface active
MediaType.Schema field v3 compatibility surface active
MediaType.SchemaRef field v3 compatibility surface active
Metrics const v3 compatibility surface active
NewRegistry func v3 compatibility surface active
NewRegistryProvider func v3 compatibility surface active
NewRegistryWithOptions func v3 compatibility surface active
NullableSchema func v3 compatibility surface active
OpenAPIVersion type v3 compatibility surface active
OpenAPIVersion30 const v3 compatibility surface active
OpenAPIVersion31 const v3 compatibility surface active
Operation type v3 compatibility surface active
Operation.Deprecated field v3 compatibility surface active
Operation.Description field v3 compatibility surface active
Operation.Extensions field v3 compatibility surface active
Operation.Method field v3 compatibility surface active
Operation.OperationID field v3 compatibility surface active
Operation.Parameters field v3 compatibility surface active
Operation.Path field v3 compatibility surface active
Operation.RequestBody field v3 compatibility surface active
Operation.Responses field v3 compatibility surface active
Operation.Scopes field v3 compatibility surface active
Operation.Security field v3 compatibility surface active
Operation.Summary field v3 compatibility surface active
Operation.Sunset field v3 compatibility surface active
Operation.Tags field v3 compatibility surface active
Parameter type v3 compatibility surface active
Parameter.Description field v3 compatibility surface active
Parameter.In field v3 compatibility surface active
Parameter.Name field v3 compatibility surface active
Parameter.Required field v3 compatibility surface active
Parameter.Schema field v3 compatibility surface active
PprofCmdline const v3 compatibility surface active
PprofEndpoints var v3 compatibility surface active
PprofIndex const v3 compatibility surface active
PprofProfile const v3 compatibility surface active
PprofSymbol const v3 compatibility surface active
PprofTrace const v3 compatibility surface active
ProblemResponse func v3 compatibility surface active
ProblemSchema func v3 compatibility surface active
Readyz const v3 compatibility surface active
RegisterHTTPProblemResponses func v3 compatibility surface active
RegisterProblemCatalog func v3 compatibility surface active
RegisterSchemaFrom func v3 compatibility surface active
Registry type v3 compatibility surface active
Registry.OpenAPI method v3 compatibility surface active
Registry.Operations method v3 compatibility surface active
Registry.Register method v3 compatibility surface active
Registry.RegisterResponse method v3 compatibility surface active
Registry.RegisterSchema method v3 compatibility surface active
Registry.RegisterSecurityScheme method v3 compatibility surface active
Registry.SetComponents method v3 compatibility surface active
Registry.SetSecurity method v3 compatibility surface active
Registry.SetServers method v3 compatibility surface active
RegistryOptions type v3 compatibility surface active
RegistryOptions.OpenAPIVersion field v3 compatibility surface active
RegistryProvider type v3 compatibility surface active
RegistryProvider.GetHTML method v3 compatibility surface active
RegistryProvider.GetInfo method v3 compatibility surface active
RegistryProvider.GetOpenAPI method v3 compatibility surface active
RegistryProvider.GetVersion method v3 compatibility surface active
RequestBody type v3 compatibility surface active
RequestBody.Content field v3 compatibility surface active
RequestBody.ContentTypes field v3 compatibility surface active
RequestBody.Description field v3 compatibility surface active
RequestBody.Required field v3 compatibility surface active
Response type v3 compatibility surface active
Response.Content field v3 compatibility surface active
Response.ContentTypes field v3 compatibility surface active
Response.Description field v3 compatibility surface active
Response.Ref field v3 compatibility surface active
SchemaFrom func v3 compatibility surface active
SchemaFromType func v3 compatibility surface active
SchemaOptions type v3 compatibility surface active
SchemaOptions.RefPrefix field v3 compatibility surface active
SchemaRef func v3 compatibility surface active
SchemaWithEnum func v3 compatibility surface active
SchemaWithExample func v3 compatibility surface active
SecurityRequirement type v3 compatibility surface active
SecurityRequirement.Name field v3 compatibility surface active
SecurityRequirement.Scopes field v3 compatibility surface active
SecurityScheme type v3 compatibility surface active
SecurityScheme.BearerFormat field v3 compatibility surface active
SecurityScheme.Description field v3 compatibility surface active
SecurityScheme.Flows field v3 compatibility surface active
SecurityScheme.In field v3 compatibility surface active
SecurityScheme.Name field v3 compatibility surface active
SecurityScheme.OpenIDConnectURL field v3 compatibility surface active
SecurityScheme.Scheme field v3 compatibility surface active
SecurityScheme.Type field v3 compatibility surface active
Server type v3 compatibility surface active
Server.Description field v3 compatibility surface active
Server.URL field v3 compatibility surface active
SystemEndpoints var v3 compatibility surface active
ValidationProblemResponse func v3 compatibility surface active
Version const v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/swagstub

Stability tier: compatibility-only

Symbol Kind Added version Deprecation status
Get func v3 compatibility surface active
List func v3 compatibility surface active
Register func v3 compatibility surface active
Spec type v3 compatibility surface active
Spec.BasePath field v3 compatibility surface active
Spec.Description field v3 compatibility surface active
Spec.Host field v3 compatibility surface active
Spec.InfoInstanceName field v3 compatibility surface active
Spec.InstanceName method v3 compatibility surface active
Spec.LeftDelim field v3 compatibility surface active
Spec.RightDelim field v3 compatibility surface active
Spec.Schemes field v3 compatibility surface active
Spec.SwaggerTemplate field v3 compatibility surface active
Spec.Title field v3 compatibility surface active
Spec.Version field v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/upload

Stability tier: stable

Symbol Kind Added version Deprecation status
AllowedContentTypes func v3 compatibility surface active
Config type v3 compatibility surface active
Config.AllowedContentTypes field v3 compatibility surface active
Config.MaxFileBytes field v3 compatibility surface active
Config.MaxMemory field v3 compatibility surface active
Config.MaxRequestBytes field v3 compatibility surface active
Config.RequiredFiles field v3 compatibility surface active
DecodeMultipart func v3 compatibility surface active
File type v3 compatibility surface active
File.ContentType field v3 compatibility surface active
File.FieldName field v3 compatibility surface active
File.FileHeader field v3 compatibility surface active
File.Filename field v3 compatibility surface active
File.Header field v3 compatibility surface active
File.Open method v3 compatibility surface active
File.Size field v3 compatibility surface active
Form type v3 compatibility surface active
Form.Files field v3 compatibility surface active
Form.Values field v3 compatibility surface active
MaxFileBytes func v3 compatibility surface active
RequireFile func v3 compatibility surface active
ValidationProblem func v3 compatibility surface active
WriteValidationProblem func v3 compatibility surface active

github.com/aatuh/api-toolkit/v4/webhooks

Stability tier: stable

Symbol Kind Added version Deprecation status
BuildSignedRequest func v3 compatibility surface active
CheckReplayWindow func v3 compatibility surface active
DecodeJSON func v3 compatibility surface active
DeliveryAttempt type v3 compatibility surface active
DeliveryAttempt.Attempt field v3 compatibility surface active
DeliveryAttempt.EventID field v3 compatibility surface active
DeliveryAttempt.Timestamp field v3 compatibility surface active
DeliveryAttempt.URL field v3 compatibility surface active
DeliveryContract type v3 compatibility surface active
DeliveryContract.AcceptedStatus field v3 compatibility surface active
DeliveryContract.MaxAttempts field v3 compatibility surface active
DeliveryContract.RetryAfter field v3 compatibility surface active
DeliveryProblem func v3 compatibility surface active
DeliveryResult type v3 compatibility surface active
DeliveryResult.Accepted field v3 compatibility surface active
DeliveryResult.Problem field v3 compatibility surface active
DeliveryResult.StatusCode field v3 compatibility surface active
ErrInvalidSignature var v3 compatibility surface active
ErrMissingSignature var v3 compatibility surface active
Event type v3 compatibility surface active
Event.Payload field v3 compatibility surface active
Event.RawBody field v3 compatibility surface active
Event.Request field v3 compatibility surface active
EventIDHeader const v3 compatibility surface active
HMACConfig type v3 compatibility surface active
HMACConfig.Encoding field v3 compatibility surface active
HMACConfig.HeaderName field v3 compatibility surface active
HMACConfig.Prefix field v3 compatibility surface active
HMACConfig.Secret field v3 compatibility surface active
HMACSignerConfig type v3 compatibility surface active
HMACSignerConfig.Encoding field v3 compatibility surface active
HMACSignerConfig.Prefix field v3 compatibility surface active
HMACSignerConfig.Secret field v3 compatibility surface active
NewHMACSHA256Signer func v3 compatibility surface active
NewHMACSHA256Verifier func v3 compatibility surface active
OutgoingEvent type v3 compatibility surface active
OutgoingEvent.ID field v3 compatibility surface active
OutgoingEvent.Payload field v3 compatibility surface active
OutgoingEvent.Type field v3 compatibility surface active
Receiver type v3 compatibility surface active
Receiver.Config field v3 compatibility surface active
Receiver.ServeHTTP method v3 compatibility surface active
ReceiverConfig type v3 compatibility surface active
ReceiverConfig.Decode field v3 compatibility surface active
ReceiverConfig.ErrorWriter field v3 compatibility surface active
ReceiverConfig.Handle field v3 compatibility surface active
ReceiverConfig.MaxBodyBytes field v3 compatibility surface active
ReceiverConfig.Replay field v3 compatibility surface active
ReceiverConfig.VerificationErrorDetail field v3 compatibility surface active
ReceiverConfig.Verifier field v3 compatibility surface active
ReplayConfig type v3 compatibility surface active
ReplayConfig.EventIDHeader field v3 compatibility surface active
ReplayConfig.Now field v3 compatibility surface active
ReplayConfig.RequireEventID field v3 compatibility surface active
ReplayConfig.TimestampHeader field v3 compatibility surface active
ReplayConfig.Tolerance field v3 compatibility surface active
ReplayDecision type v3 compatibility surface active
ReplayDecision.Allowed field v3 compatibility surface active
ReplayDecision.EventID field v3 compatibility surface active
ReplayDecision.Reason field v3 compatibility surface active
ReplayDecision.Timestamp field v3 compatibility surface active
SignatureEncoding type v3 compatibility surface active
SignatureEncodingBase64 const v3 compatibility surface active
SignatureEncodingBase64URL const v3 compatibility surface active
SignatureEncodingHex const v3 compatibility surface active
SignedRequestConfig type v3 compatibility surface active
SignedRequestConfig.ContentType field v3 compatibility surface active
SignedRequestConfig.EventID field v3 compatibility surface active
SignedRequestConfig.EventIDHeader field v3 compatibility surface active
SignedRequestConfig.Headers field v3 compatibility surface active
SignedRequestConfig.Method field v3 compatibility surface active
SignedRequestConfig.SignatureHeader field v3 compatibility surface active
SignedRequestConfig.Signer field v3 compatibility surface active
SignedRequestConfig.Timestamp field v3 compatibility surface active
SignedRequestConfig.TimestampHeader field v3 compatibility surface active
SignedRequestConfig.URL field v3 compatibility surface active
Signer type v3 compatibility surface active
Signer.SignWebhook interface method v3 compatibility surface active
SignerFunc type v3 compatibility surface active
SignerFunc.SignWebhook method v3 compatibility surface active
TimestampHeader const v3 compatibility surface active
Verifier type v3 compatibility surface active
Verifier.VerifyWebhook interface method v3 compatibility surface active
VerifierFunc type v3 compatibility surface active
VerifierFunc.VerifyWebhook method v3 compatibility surface active
WriteProblem func v3 compatibility surface active