Hide examples showing custom header setup until a clean solution is available (#430)

Hidden ./src/web/clients/requests/header.md and
./src/web/clients/api/rate-limited.md as the custom header story is being reworked
in https://github.com/hyperium/headers
This commit is contained in:
Michał Budzyński 2018-07-11 22:13:51 +02:00 committed by Andrew Gauger
parent ab7bedc0a5
commit 254ee9bf43
5 changed files with 6 additions and 7 deletions

View file

@ -21,7 +21,6 @@ env_logger = "0.5"
error-chain = "0.12" error-chain = "0.12"
flate2 = "1.0" flate2 = "1.0"
glob = "0.2" glob = "0.2"
hyper = "0.11"
image = "0.19" image = "0.19"
lazy_static = "1.0" lazy_static = "1.0"
log = "0.4" log = "0.4"

View file

@ -3,12 +3,18 @@ extern crate walkdir;
use walkdir::WalkDir; use walkdir::WalkDir;
const REMOVED_TESTS: &[&str] = &[
"./src/web/clients/requests/header.md",
"./src/web/clients/api/rate-limited.md",
];
fn main() { fn main() {
let paths = WalkDir::new("./src/").into_iter() let paths = WalkDir::new("./src/").into_iter()
// convert paths to Strings // convert paths to Strings
.map(|p| p.unwrap().path().to_str().unwrap().to_string()) .map(|p| p.unwrap().path().to_str().unwrap().to_string())
// only compile markdown files // only compile markdown files
.filter(|p| p.ends_with(".md")) .filter(|p| p.ends_with(".md"))
.filter(|p| !REMOVED_TESTS.contains(&p.as_ref()))
.collect::<Vec<_>>(); .collect::<Vec<_>>();
skeptic::generate_doc_tests(&paths[..]); skeptic::generate_doc_tests(&paths[..]);

View file

@ -3,12 +3,10 @@
| Recipe | Crates | Categories | | Recipe | Crates | Categories |
|--------|--------|------------| |--------|--------|------------|
| [Make a HTTP GET request][ex-url-basic] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] | | [Make a HTTP GET request][ex-url-basic] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] |
| [Set custom headers and URL parameters for a REST request][ex-rest-custom-params] | [![reqwest-badge]][reqwest] [![hyper-badge]][hyper] [![url-badge]][url] | [![cat-net-badge]][cat-net] |
| [Query the GitHub API][ex-rest-get] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] | | [Query the GitHub API][ex-rest-get] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] |
| [Check if an API resource exists][ex-rest-head] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] | | [Check if an API resource exists][ex-rest-head] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] |
| [Create and delete Gist with GitHub API][ex-rest-post] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] | | [Create and delete Gist with GitHub API][ex-rest-post] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] |
| [Consume a paginated RESTful API][ex-paginated-api] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] | | [Consume a paginated RESTful API][ex-paginated-api] | [![reqwest-badge]][reqwest] [![serde-badge]][serde] | [![cat-net-badge]][cat-net] [![cat-encoding-badge]][cat-encoding] |
| [Handle a rate-limited API][ex-handle-rate-limited-api] | [![reqwest-badge]][reqwest] [![hyper-badge]][hyper] | [![cat-net-badge]][cat-net] |
| [Download a file to a temporary directory][ex-url-download] | [![reqwest-badge]][reqwest] [![tempdir-badge]][tempdir] | [![cat-net-badge]][cat-net] [![cat-filesystem-badge]][cat-filesystem] | | [Download a file to a temporary directory][ex-url-download] | [![reqwest-badge]][reqwest] [![tempdir-badge]][tempdir] | [![cat-net-badge]][cat-net] [![cat-filesystem-badge]][cat-filesystem] |
| [Make a partial download with HTTP range headers][ex-progress-with-range] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] | | [Make a partial download with HTTP range headers][ex-progress-with-range] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] |
| [POST a file to paste-rs][ex-file-post] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] | | [POST a file to paste-rs][ex-file-post] | [![reqwest-badge]][reqwest] | [![cat-net-badge]][cat-net] |

View file

@ -8,6 +8,4 @@
{{#include api/paginated.md}} {{#include api/paginated.md}}
{{#include api/rate-limited.md}}
{{#include ../../links.md}} {{#include ../../links.md}}

View file

@ -2,6 +2,4 @@
{{#include requests/get.md}} {{#include requests/get.md}}
{{#include requests/header.md}}
{{#include ../../links.md}} {{#include ../../links.md}}