Skip to content
This repository was archived by the owner on Oct 23, 2022. It is now read-only.

Commit ae29c0a

Browse files
author
Joonas Koivunen
committed
doc: top level docs for http as well
1 parent 2c16ad7 commit ae29c0a

File tree

3 files changed

+10
-1
lines changed

3 files changed

+10
-1
lines changed

http/src/config.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
//! go-ipfs compatible configuration file handling or at least setup.
1+
//! go-ipfs compatible configuration file handling and setup.
22
33
use parity_multiaddr::Multiaddr;
44
use serde::{Deserialize, Serialize};

http/src/lib.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
//! `ipfs-http` http API implementation.
2+
//!
3+
//! This crate is most useful as a binary used first and foremost for compatibility testing against
4+
//! other ipfs implementations.
5+
16
#[macro_use]
27
extern crate tracing;
38

http/src/v0.rs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
//! Implementation of `/api/v0` HTTP endpoints.
2+
//!
3+
//! See https://docs.ipfs.io/reference/http/api/ for more information.
4+
15
use ipfs::{Ipfs, IpfsTypes};
26
use warp::{query, Filter};
37

0 commit comments

Comments
 (0)