Documentation ¶
Overview ¶
Package api provides the functionality of the Bee client-facing HTTP API.
Index ¶
Constants ¶
View Source
const ( SwarmPinHeader = "Swarm-Pin" SwarmTagHeader = "Swarm-Tag" SwarmEncryptHeader = "Swarm-Encrypt" SwarmIndexDocumentHeader = "Swarm-Index-Document" SwarmErrorDocumentHeader = "Swarm-Error-Document" SwarmFeedIndexHeader = "Swarm-Feed-Index" SwarmFeedIndexNextHeader = "Swarm-Feed-Index-Next" SwarmCollectionHeader = "Swarm-Collection" SwarmPostageBatchIdHeader = "Swarm-Postage-Batch-Id" )
View Source
const (
// TargetsRecoveryHeader defines the Header for Recovery targets in Global Pinning
TargetsRecoveryHeader = "swarm-recovery-targets"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Service ¶
Service is the API service interface.
func New ¶
func New(tags *tags.Tags, storer storage.Storer, resolver resolver.Interface, pss pss.Interface, traversalService traversal.Traverser, pinning pinning.Interface, feedFactory feeds.Factory, post postage.Service, postageContract postagecontract.Interface, steward steward.Reuploader, signer crypto.Signer, logger logging.Logger, tracer *tracing.Tracer, o Options) Service
New will create a and initialize a new API service.
type UpgradedResponseWriter ¶ added in v0.6.0
type UpgradedResponseWriter interface { http.ResponseWriter http.Pusher http.Hijacker http.Flusher // staticcheck SA1019 CloseNotifier interface is required by gorilla compress handler // nolint:staticcheck http.CloseNotifier // skipcq: SCC-SA1019 }
UpgradedResponseWriter adds more functionality on top of ResponseWriter
Click to show internal directories.
Click to hide internal directories.