validator-api: tidy swagger stuff

validator-api/src/contract_cache/mod.rs

@@ -2,7 +2,6 @@
 // SPDX-License-Identifier: Apache-2.0
 
 use crate::nymd_client::Client;
-use rocket_okapi::openapi_get_routes;
 use ::time::OffsetDateTime;
 use anyhow::Result;
 use config::defaults::VALIDATOR_API_VERSION;
@@ -10,6 +9,7 @@ use mixnet_contract_common::reward_params::EpochRewardParams;
 use mixnet_contract_common::{
     GatewayBond, IdentityKey, IdentityKeyRef, Interval, MixNodeBond, RewardedSetNodeStatus,
 };
+use rocket_okapi::openapi_get_routes;
 
 use rocket::fairing::AdHoc;
 use serde::Serialize;
@@ -180,7 +180,7 @@ impl<C> ValidatorCacheRefresher<C> {
 }
 
 impl ValidatorCache {
-    pub fn new() -> Self {
+    fn new() -> Self {
         ValidatorCache {
             initialised: Arc::new(AtomicBool::new(false)),
             inner: Arc::new(RwLock::new(ValidatorCacheInner::new())),
@@ -189,13 +189,10 @@ impl ValidatorCache {
 
     pub fn stage() -> AdHoc {
         AdHoc::on_ignite("Validator Cache Stage", |rocket| async {
-            rocket
-                .manage(Self::new())
-                .mount(
+            rocket.manage(Self::new()).mount(
                 // this format! is so ugly...
                 format!("/{}", VALIDATOR_API_VERSION),
                 openapi_get_routes![
-                //routes![
                     routes::get_mixnodes,
                     routes::get_gateways,
                     routes::get_active_set,

validator-api/src/contract_cache/routes.rs

@@ -55,8 +55,7 @@ pub async fn get_epoch_reward_params(cache: &State<ValidatorCache>) -> Json<Epoc
     Json(cache.epoch_reward_params().await.value)
 }
 
-// WIP(JON)
-#[openapi(tag = "contract-cache", skip)]
+#[openapi(tag = "contract-cache")]
 #[get("/epoch/current")]
 pub async fn get_current_epoch(cache: &State<ValidatorCache>) -> Json<Option<Interval>> {
     Json(cache.current_epoch().await.value)

validator-api/src/node_status_api/models.rs

@@ -9,9 +9,9 @@ use rocket::response::{self, Responder, Response};
 use rocket::Request;
 use rocket_okapi::gen::OpenApiGenerator;
 use rocket_okapi::response::OpenApiResponderInner;
-use schemars::JsonSchema;
 use schemars::gen::SchemaGenerator;
-use schemars::schema::{Schema, InstanceType};
+use schemars::schema::{InstanceType, Schema};
+use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use std::convert::TryFrom;
 use std::fmt::{self, Display, Formatter};
@@ -269,19 +269,16 @@ impl JsonSchema for ErrorResponse {
         object_validation
             .properties
             .insert("status".to_owned(), gen.subschema_for::<u16>());
-        object_validation
-            .required
-            .insert("status".to_owned());
+        object_validation.required.insert("status".to_owned());
 
         Schema::Object(schema_object)
     }
 }
 
-
 impl OpenApiResponderInner for ErrorResponse {
     fn responses(_gen: &mut OpenApiGenerator) -> rocket_okapi::Result<Responses> {
         let responses = Responses::default();
-        // WIP(JON)
+        // WIP(JON): handle responses correctly
         Ok(responses)
     }
 }