Merge pull request #9 from fussybeaver/ND-fix-examples-docs-2.1

Fix example and doc tests

.github/workflows/main.yml

@@ -22,6 +22,12 @@ jobs:
         with:
           command: check
 
+      - name: Run cargo check --examples
+        uses: actions-rs/cargo@v1
+        with:
+          command: check
+          args: --examples
+
   test:
     name: Test Suite
     runs-on: ubuntu-latest
@@ -66,6 +72,12 @@ jobs:
           command: test
           args: services
 
+      - name: Run doc tests
+        uses: actions-rs/cargo@v1
+        with:
+          command: test
+          args: --doc
+
       - name: Emit logs of mock server
         if: always()
         run: docker-compose logs

.gitignore

@@ -8,4 +8,5 @@
 
 src/endpoints/*_swagger.rs
 /*.json
-/templates/api.mustache
+/templates/api.mustache
+/Cargo.lock

Cargo.toml

@@ -2,7 +2,7 @@
 name = "praiya"
 description = "An async PagerDuty API client"
 license = "Apache-2.0"
-version = "0.2.0"
+version = "0.2.1"
 authors = ["Praiya contributors"]
 homepage = "https://github.com/fussybeaver/praiya"
 repository = "https://github.com/fussybeaver/praiya"

README.md

@@ -20,7 +20,7 @@ Add the following to your `Cargo.toml` file.
 
 ```nocompile
 [dependencies]
-praiya = "0.2.0"
+praiya = "*"
 ```
 
 ## API
@@ -79,7 +79,7 @@ use futures_util::TryStreamExt;
 
 let pagerduty = praiya::Praiya::new("PAGERDUTY_TOKEN");
 
-let mut opts_builder = praiya::endpoints::incidents::IncidentsListIncidentsParamsBuilder::new();
+let mut opts_builder = praiya::endpoints::incidents::ListIncidentsParamsBuilder::new();
 opts_builder.statuses(vec!["triggered", "acknowledged"]);
 let opts = opts_builder.build();
 
@@ -149,7 +149,7 @@ env PAGERDUTY_API_ENDPOINT=http://127.0.0.1:8081 RUST_LOG=praiya=debug cargo tes
 
 This README is generated with [cargo-readme](https://github.com/livioribeiro/cargo-readme)
 
-```rust
+```nocompile
 cargo readme --no-title > README.md
 ```
 

examples/switch_incident_slack.rs

@@ -5,7 +5,7 @@ use std::collections::HashSet;
 
 use futures_util::TryStreamExt;
 use praiya::{
-    api::incidents::IncidentsListIncidentsParamsBuilder,
+    api::incidents::ListIncidentsParamsBuilder,
     default_models::{Incident, ServiceReference},
     slack_models::SlackConnection,
     ParamsBuilder, Praiya,
@@ -22,7 +22,7 @@ async fn main() -> Result<(), praiya::errors::Error> {
     let pagerduty = Praiya::new(PAGERDUTY_TOKEN);
 
     let params = {
-        let mut option = IncidentsListIncidentsParamsBuilder::new();
+        let mut option = ListIncidentsParamsBuilder::new();
         let statuses = vec!["triggered", "acknowledged"];
         option.statuses(statuses);
         option.build()

src/lib.rs

@@ -20,7 +20,7 @@
 //!
 //! ```nocompile
 //! [dependencies]
-//! praiya = "0.2.0"
+//! praiya = "*"
 //! ```
 //!
 //! # API
@@ -79,7 +79,7 @@
 //!
 //! let pagerduty = praiya::Praiya::new("PAGERDUTY_TOKEN");
 //!
-//! let mut opts_builder = praiya::endpoints::incidents::IncidentsListIncidentsParamsBuilder::new();
+//! let mut opts_builder = praiya::endpoints::incidents::ListIncidentsParamsBuilder::new();
 //! opts_builder.statuses(vec!["triggered", "acknowledged"]);
 //! let opts = opts_builder.build();
 //!
@@ -149,7 +149,7 @@
 //!
 //! This README is generated with [cargo-readme](https://github.com/livioribeiro/cargo-readme)
 //!
-//! ```
+//! ```nocompile
 //! cargo readme --no-title > README.md
 //! ```
 //!