Categorygithub.com/ipfs/http-api-docs
modulepackage
0.0.0-20210921212942-659c3a4dbbb1
Repository: https://github.com/ipfs/http-api-docs.git
Documentation: pkg.go.dev

# README

# Packages

This is an utility to generate documentation from go-ipfs commands.

# Functions

AllEndpoints gathers all the endpoints from go-ipfs.
Endpoints receives a name and a go-ipfs command and returns the endpoints it defines] (sorted).
GenerateDocs uses a formatter to generate documentation for every endpoint.
No description provided by the author

# Constants

No description provided by the author
How much to indent when generating the response schemas.
Failsafe when traversing objects containing objects of the same type.

# Variables

A map of single endpoints to be skipped (subcommands are processed though).
No description provided by the author

# Structs

Argument defines an IPFS RPC API endpoint argument.
Endpoint defines an IPFS RPC API endpoint.
MarkdownFormatter implements a markdown doc generator.

# Interfaces

Formatter allows to implement generation of docs in different formats.