encapsulate use of #[derive(JsonSchema)]

dropshot/examples/basic.rs

@@ -8,13 +8,13 @@ use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
+use dropshot::ExtractedParameter;
 use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::HttpResponseUpdatedNoContent;
 use dropshot::HttpServer;
 use dropshot::RequestContext;
 use dropshot::TypedBody;
-use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 use std::any::Any;
@@ -107,7 +107,7 @@ impl ExampleContext {
  * response to a GET request to fetch the counter or as the body of a PUT
  * request to update the counter.
  */
-#[derive(Deserialize, Serialize, JsonSchema)]
+#[derive(Deserialize, Serialize, ExtractedParameter)]
 struct CounterValue {
     counter: u64,
 }

dropshot/examples/pagination-basic.rs

@@ -22,6 +22,7 @@ use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
 use dropshot::EmptyScanParams;
+use dropshot::ExtractedParameter;
 use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::HttpServer;
@@ -30,7 +31,6 @@ use dropshot::Query;
 use dropshot::RequestContext;
 use dropshot::ResultsPage;
 use dropshot::WhichPage;
-use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 use std::collections::BTreeMap;
@@ -42,10 +42,10 @@ use std::sync::Arc;
 /**
  * Object returned by our paginated endpoint
  *
- * Like anything returned by Dropshot, we must implement `JsonSchema` and
+ * Like anything returned by Dropshot, we must implement `ExtractedParameter` and
  * `Serialize`.  We also implement `Clone` to simplify the example.
  */
-#[derive(Clone, JsonSchema, Serialize)]
+#[derive(Clone, ExtractedParameter, Serialize)]
 struct Project {
     name: String,
     // lots more fields
@@ -61,7 +61,7 @@ struct Project {
  * include with each page of results, and it must be `Deserialize` to get it
  * back in a querystring.
  */
-#[derive(Deserialize, JsonSchema, Serialize)]
+#[derive(Deserialize, ExtractedParameter, Serialize)]
 struct ProjectPage {
     name: String,
 }

dropshot/examples/pagination-multiple-resources.rs

@@ -10,6 +10,7 @@ use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
+use dropshot::ExtractedParameter;
 use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::HttpServer;
@@ -21,7 +22,6 @@ use dropshot::Query;
 use dropshot::RequestContext;
 use dropshot::ResultsPage;
 use dropshot::WhichPage;
-use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 use std::collections::BTreeMap;
@@ -36,21 +36,21 @@ use uuid::Uuid;
  * "name".  We'll have one endpoint for each resource to list it.
  */
 
-#[derive(Clone, JsonSchema, Serialize)]
+#[derive(Clone, ExtractedParameter, Serialize)]
 struct Project {
     id: Uuid,
     name: String,
     // lots more project-like fields
 }
 
-#[derive(Clone, JsonSchema, Serialize)]
+#[derive(Clone, ExtractedParameter, Serialize)]
 struct Disk {
     id: Uuid,
     name: String,
     // lots more disk-like fields
 }
 
-#[derive(Clone, JsonSchema, Serialize)]
+#[derive(Clone, ExtractedParameter, Serialize)]
 struct Instance {
     id: Uuid,
     name: String,
@@ -88,7 +88,7 @@ impl_HasIdentity!(Instance);
 /*
  * Pagination-related types
  */
-#[derive(Deserialize, Clone, JsonSchema, Serialize)]
+#[derive(Deserialize, Clone, ExtractedParameter, Serialize)]
 struct ExScanParams {
     #[serde(default = "default_sort_mode")]
     sort: ExSortMode,
@@ -98,7 +98,7 @@ fn default_sort_mode() -> ExSortMode {
     ExSortMode::ByNameAscending
 }
 
-#[derive(Deserialize, Clone, JsonSchema, Serialize)]
+#[derive(Deserialize, Clone, ExtractedParameter, Serialize)]
 #[serde(rename_all = "kebab-case")]
 enum ExSortMode {
     ByIdAscending,
@@ -107,7 +107,7 @@ enum ExSortMode {
     ByNameDescending,
 }
 
-#[derive(Debug, Deserialize, JsonSchema, Serialize)]
+#[derive(Debug, Deserialize, ExtractedParameter, Serialize)]
 #[serde(rename_all = "kebab-case")]
 enum ExPageSelector {
     Id(PaginationOrder, Uuid),
@@ -251,7 +251,7 @@ fn do_list<'a, T>(
     by_id: &'a BTreeMap<Uuid, Arc<T>>,
 ) -> ItemIter<'a, T>
 where
-    T: Clone + JsonSchema + Serialize + Send + Sync + 'static,
+    T: Clone + ExtractedParameter + Serialize + Send + Sync + 'static,
 {
     match p {
         WhichPage::First(_) => match scan_params.sort {

dropshot/examples/pagination-multiple-sorts.rs

@@ -98,6 +98,7 @@ use dropshot::ApiDescription;
 use dropshot::ConfigDropshot;
 use dropshot::ConfigLogging;
 use dropshot::ConfigLoggingLevel;
+use dropshot::ExtractedParameter;
 use dropshot::HttpError;
 use dropshot::HttpResponseOk;
 use dropshot::HttpServer;
@@ -110,7 +111,6 @@ use dropshot::RequestContext;
 use dropshot::ResultsPage;
 use dropshot::WhichPage;
 use hyper::Uri;
-use schemars::JsonSchema;
 use serde::Deserialize;
 use serde::Serialize;
 use std::collections::BTreeMap;
@@ -125,10 +125,10 @@ extern crate slog;
 /**
  * Item returned by our paginated endpoint
  *
- * Like anything returned by Dropshot, we must implement `JsonSchema` and
+ * Like anything returned by Dropshot, we must implement `ExtractedParameter` and
  * `Serialize`.  We also implement `Clone` to simplify the example.
  */
-#[derive(Clone, JsonSchema, Serialize)]
+#[derive(Clone, ExtractedParameter, Serialize)]
 struct Project {
     name: String,
     mtime: DateTime<Utc>,
@@ -148,7 +148,7 @@ struct Project {
  * serialize it using `serde_querystring`.  That code could fail at runtime for
  * certain types of values (e.g., enum variants that contain data).
  */
-#[derive(Clone, Deserialize, JsonSchema, Serialize)]
+#[derive(Clone, Deserialize, ExtractedParameter, Serialize)]
 struct ProjectScanParams {
     #[serde(default = "default_project_sort")]
     sort: ProjectSort,
@@ -158,7 +158,7 @@ fn default_project_sort() -> ProjectSort {
     ProjectSort::ByNameAscending
 }
 
-#[derive(Deserialize, Clone, JsonSchema, Serialize)]
+#[derive(Deserialize, Clone, ExtractedParameter, Serialize)]
 #[serde(rename_all = "kebab-case")]
 enum ProjectSort {
     /** by name ascending */
@@ -186,7 +186,7 @@ enum ProjectSort {
  * selector back, you find the object having the next value after the one stored
  * in the token and start returning results from there.
  */
-#[derive(Deserialize, JsonSchema, Serialize)]
+#[derive(Deserialize, ExtractedParameter, Serialize)]
 #[serde(rename_all = "kebab-case")]
 enum ProjectScanPageSelector {
     Name(PaginationOrder, String),

dropshot/examples/petstore.rs

@@ -1,8 +1,7 @@
 use dropshot::{
-    endpoint, ApiDescription, HttpError, HttpResponseOk, PaginationParams,
-    Path, Query, RequestContext, ResultsPage, TypedBody,
+    endpoint, ApiDescription, ExtractedParameter, HttpError, HttpResponseOk,
+    PaginationParams, Path, Query, RequestContext, ResultsPage, TypedBody,
 };
-use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::sync::Arc;
 
@@ -33,7 +32,7 @@ fn main() -> Result<(), String> {
 }
 
 #[allow(dead_code)]
-#[derive(Deserialize, Serialize, JsonSchema)]
+#[derive(Deserialize, Serialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct Pet {
     id: Option<i64>,
@@ -47,20 +46,20 @@ struct Pet {
 }
 
 #[allow(dead_code)]
-#[derive(Deserialize, Serialize, JsonSchema)]
+#[derive(Deserialize, Serialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct Category {
     id: i64,
     name: String,
 }
 
 #[allow(dead_code)]
-#[derive(Deserialize, Serialize, JsonSchema)]
+#[derive(Deserialize, Serialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct Tag {}
 
 #[allow(dead_code)]
-#[derive(Deserialize, Serialize, JsonSchema)]
+#[derive(Deserialize, Serialize, ExtractedParameter)]
 #[serde(rename_all = "lowercase")]
 enum PetStatus {
     Available,
@@ -69,7 +68,7 @@ enum PetStatus {
 }
 
 #[allow(dead_code)]
-#[derive(Deserialize, JsonSchema)]
+#[derive(Deserialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct PathParams {
     pet_id: i64,
@@ -113,15 +112,15 @@ async fn update_pet_with_form(
 }
 
 #[allow(dead_code)]
-#[derive(Deserialize, JsonSchema)]
+#[derive(Deserialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct FindByTagsScanParams {
     /// Tags to filter for
     tags: String,
 }
 
 #[allow(dead_code)]
-#[derive(Serialize, Deserialize, JsonSchema)]
+#[derive(Serialize, Deserialize, ExtractedParameter)]
 #[serde(rename_all = "camelCase")]
 struct FindByTagsPageSelector {
     tags: String,

dropshot/src/api_description.rs

@@ -856,14 +856,14 @@ mod test {
     use super::j2oas_schema;
     use super::ApiDescription;
     use super::ApiEndpoint;
+    use crate::ExtractedParameter;
     use http::Method;
     use hyper::Body;
     use hyper::Response;
-    use schemars::JsonSchema;
     use serde::Deserialize;
     use std::sync::Arc;
 
-    #[derive(Deserialize, JsonSchema)]
+    #[derive(Deserialize, ExtractedParameter)]
     #[allow(dead_code)]
     struct TestPath {
         a: String,
@@ -927,7 +927,7 @@ mod test {
 
     #[test]
     fn test_empty_struct() {
-        #[derive(JsonSchema)]
+        #[derive(ExtractedParameter)]
         struct Empty {}
 
         let settings = schemars::gen::SchemaSettings::openapi3();
@@ -940,7 +940,7 @@ mod test {
     #[test]
     fn test_garbage_barge_structure_conversion() {
         #[allow(dead_code)]
-        #[derive(JsonSchema)]
+        #[derive(ExtractedParameter)]
         struct SuperGarbage {
             string: String,
             strings: Vec<String>,
@@ -952,7 +952,7 @@ mod test {
         }
 
         #[allow(dead_code)]
-        #[derive(JsonSchema)]
+        #[derive(ExtractedParameter)]
         struct Substruct {
             ii32: i32,
             uu64: u64,
@@ -962,7 +962,7 @@ mod test {
         }
 
         #[allow(dead_code)]
-        #[derive(JsonSchema)]
+        #[derive(ExtractedParameter)]
         enum Union {
             A { a: u32 },
             B { b: f32 },