Add examples

fossas · May 15, 2024 · f558858 · f558858
1 parent e90f449
commit f558858
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 1 deletion.
diff --git a/Cargo.toml b/Cargo.toml
@@ -13,6 +13,7 @@ pretty_assertions = "1.4.0"
 regex = "1.6.0"
 schemars = "0.8.19"
 serde = { version = "1.0.140", features = ["derive"] }
+serde_json = "1.0.95"
 strum = { version = "0.24.1", features = ["derive"] }
 thiserror = "1.0.31"
 typed-builder = "0.10.0"
@@ -21,4 +22,3 @@ typed-builder = "0.10.0"
 assert_matches = "1.5.0"
 itertools = "0.10.5"
 proptest = "1.0.0"
-serde_json = "1.0.95"
diff --git a/src/locator.rs b/src/locator.rs
@@ -9,6 +9,7 @@ use schemars::{
     JsonSchema,
 };
 use serde::{Deserialize, Serialize};
+use serde_json::json;
 use typed_builder::TypedBuilder;
 
 use crate::{parse_org_project, Error, Fetcher, PackageLocator, ParseError, StrictLocator};
@@ -286,6 +287,7 @@ impl JsonSchema for Locator {
                     "}
                     .to_string(),
                 ),
+                examples: vec![json!("git+github.com/fossas/example$1234")],
                 ..Default::default()
             })),
             ..Default::default()

diff --git a/src/locator_package.rs b/src/locator_package.rs
@@ -7,6 +7,7 @@ use schemars::{
     JsonSchema,
 };
 use serde::{Deserialize, Serialize};
+use serde_json::json;
 use typed_builder::TypedBuilder;
 
 use crate::{Error, Fetcher, Locator, StrictLocator};
@@ -161,6 +162,7 @@ impl JsonSchema for PackageLocator {
                     "}
                     .to_string(),
                 ),
+                examples: vec![json!("git+github.com/fossas/example")],
                 ..Default::default()
             })),
             ..Default::default()

diff --git a/src/locator_strict.rs b/src/locator_strict.rs
@@ -7,6 +7,7 @@ use schemars::{
     JsonSchema,
 };
 use serde::{Deserialize, Serialize};
+use serde_json::json;
 use typed_builder::TypedBuilder;
 
 use crate::{Error, Fetcher, Locator, PackageLocator, ParseError};
@@ -186,6 +187,7 @@ impl JsonSchema for StrictLocator {
                     "}
                     .to_string(),
                 ),
+                examples: vec![json!("git+github.com/fossas/example$1234")],
                 ..Default::default()
             })),
             ..Default::default()