Add descriptions to OpenAPI schema properties#5339
Open
crtahlin wants to merge 1 commit intoethersphere:masterfrom
Open
Add descriptions to OpenAPI schema properties#5339crtahlin wants to merge 1 commit intoethersphere:masterfrom
crtahlin wants to merge 1 commit intoethersphere:masterfrom
Conversation
Add detailed descriptions to schema properties across both Swarm.yaml and SwarmCommon.yaml to improve API documentation clarity: - Addresses, BzzTopology, PeerMetricsView, BlockListedPeers schemas - ReserveState, ChainState, AccountingInfo, Settlement schemas - PostageBatch, PostageBatchShort, PostageStampBuckets schemas - WalletResponse, TransactionInfo, ChequebookBalance schemas - RedistributionStatusResponse, StatusSnapshotResponse schemas - ApiChunkInclusionProof, ApiPostageProof, ApiSOCProof schemas - ActGranteesOperationResponse, PostEnvelopeResponse schemas - FeedType, Logger, PinCheckResponse schemas - SwarmRedundancyLevelParameter, immutable and withdrawal parameters
This was referenced Jan 29, 2026
Closed
Closed
|
This also partially addresses #5226 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Add detailed descriptions to schema properties across both
Swarm.yamlandSwarmCommon.yamlto improve API documentation clarity. This helps developers understand what each field means without having to dig through the source code.Schemas updated:
Parameters updated:
SwarmRedundancyLevelParameter- detailed explanation of each levelimmutableheader in/stamps/{amount}/{depth}/wallet/withdraw/{coin}Test plan