Skip to content
This repository has been archived by the owner on Feb 12, 2024. It is now read-only.

docs: correct the ipfs.stats.bw API options object #3984

Closed
wants to merge 1 commit into from

Conversation

SgtPooki
Copy link
Member

@SgtPooki SgtPooki commented Dec 16, 2021

This update reflects exactly what is displayed on https://docs.ipfs.io/reference/http/api/#api-v0-stats-bw

Related to #3985

peer [string]:  Required: no.

proto [string]:  Required: no.

poll [bool]:  Required: no.

interval [string]: 

This update reflects exactly what is displayed on what seems to be the official ipfs API documentation site.

@see https://docs.ipfs.io/reference/http/api/#api-v0-stats-bw
@welcome

This comment has been minimized.

@lidel
Copy link
Member

lidel commented Jan 14, 2022

Those two params are not in HTTP RPC API, but they ARE part of JS CORE API, so need to stay :)
General takeaway here we need to figure out a way for automated docs generation, so we no longer maintain these JS API docs by hand. (We already have that for HTTP RPC)

@lidel lidel closed this Jan 14, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants