Merge branch 'main' into feat/openapi-lint

Author: bkioshn

catalyst-gateway/bin/src/event_db/types/ballot.rs

@@ -12,7 +12,7 @@ pub(crate) struct ObjectiveChoices(pub(crate) Vec<String>);
 pub(crate) struct BallotType(pub(crate) String);
 
 #[derive(Debug, Clone, PartialEq, Eq)]
-/// Vote Plan
+/// Voting Plan
 pub(crate) struct VotePlan {
     /// Chain proposal index
     pub(crate) chain_proposal_index: i64,

catalyst-gateway/bin/src/service/api/health/live_get.rs

@@ -5,12 +5,14 @@ use tracing::{error, info, warn};
 
 use crate::service::common::responses::{
     resp_2xx::NoContent,
+    resp_4xx::ApiValidationError,
     resp_5xx::{ServerError, ServiceUnavailable},
 };
 
 /// All responses
 pub(crate) type AllResponses = response! {
     204: NoContent,
+    400: ApiValidationError,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -28,6 +30,7 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 204 No Content - Service is OK and can keep running.
+/// * 400 API Validation Error
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is possibly not running reliably.

catalyst-gateway/bin/src/service/api/health/ready_get.rs

@@ -13,6 +13,7 @@ use crate::{
     event_db::error::Error as DBError,
     service::common::responses::{
         resp_2xx::NoContent,
+        resp_4xx::ApiValidationError,
         resp_5xx::{server_error, ServerError, ServiceUnavailable},
     },
     state::{SchemaVersionStatus, State},
@@ -21,6 +22,7 @@ use crate::{
 /// All responses
 pub(crate) type AllResponses = response! {
     204: NoContent,
+    400: ApiValidationError,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -46,6 +48,7 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 204 No Content - Service is Ready to serve requests.
+/// * 400 API Validation Error
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is not ready, do not send other requests.

catalyst-gateway/bin/src/service/api/health/started_get.rs

@@ -4,12 +4,14 @@ use poem_extensions::{response, UniResponse::T204};
 
 use crate::service::common::responses::{
     resp_2xx::NoContent,
+    resp_4xx::ApiValidationError,
     resp_5xx::{ServerError, ServiceUnavailable},
 };
 
 /// All responses
 pub(crate) type AllResponses = response! {
     204: NoContent,
+    400: ApiValidationError,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -35,6 +37,7 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 204 No Content - Service is Started and can  serve requests.
+/// * 400 API Validation Error
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service has not started, do not send other requests.

catalyst-gateway/bin/src/service/api/registration/mod.rs

@@ -21,7 +21,7 @@ use crate::{
             },
             responses::{
                 resp_2xx::OK,
-                resp_4xx::NotFound,
+                resp_4xx::{BadRequest, NotFound},
                 resp_5xx::{server_error, ServerError, ServiceUnavailable},
             },
             tags::ApiTags,
@@ -59,14 +59,16 @@ impl RegistrationApi {
         /// The Event ID to return results for.
         /// See [GET Events](Link to events endpoint) for details on retrieving all valid
         /// event IDs.
-        #[oai(validator(minimum(value = "0")))]
+        // TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
+        #[oai(validator(minimum(value = "0"), maximum(value = "2147483647")))]
         event_id: Query<Option<EventId>>,
         /// If this optional flag is set, the response will include the delegator's list
         /// in the response. Otherwise, it will be omitted.
         #[oai(default)]
         with_delegators: Query<bool>,
     ) -> response! {
            200: OK<Json<VoterRegistration>>,
+           400: BadRequest<Json<VoterRegistration>>,
            404: NotFound,
            500: ServerError,
            503: ServiceUnavailable,

catalyst-gateway/bin/src/service/api/test_endpoints/mod.rs

@@ -57,7 +57,7 @@ impl TestApi {
         /// The action just needs to be any valid UUID.
         ///
         /// # Make sure its a UUID
-        action: Path<Option<String>>,
+        action: Path<String>,
         #[oai(validator(min_items = 0, max_items = 3, unique_items))]
         /// List your favorite pets, in order of preference
         pet: Query<Option<Vec<test_get::Animals>>>,
@@ -99,7 +99,7 @@ impl TestApi {
         /// * 10 will print a warn log
         /// * 15 will print a error log
         /// * 20 will panic which should generate a 500
-        _id: Path<i32>,
+        id: Path<i32>,
         #[oai(validator(
             pattern = "[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}",
             max_length = "36",
@@ -108,8 +108,8 @@ impl TestApi {
         /// The action just needs to be any valid UUID.
         ///
         /// # Make sure its a UUID
-        _action: Path<Option<String>>,
+        action: Path<String>,
     ) -> test_post::AllResponses {
-        test_post::endpoint().await
+        test_post::endpoint(*id, &action).await
     }
 }

catalyst-gateway/bin/src/service/api/test_endpoints/test_get.rs

@@ -48,12 +48,13 @@ pub(crate) enum Animals {
 /// ## Responses
 ///
 /// * 204 No Content - Service is OK and can keep running.
+/// * 400 API Validation Error
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is possibly not running reliably.
 #[allow(clippy::unused_async, clippy::panic)]
 pub(crate) async fn endpoint(
-    _state: Arc<State>, id: i32, action: &Option<String>, pet: &Option<Vec<Animals>>,
+    _state: Arc<State>, id: i32, action: &String, pet: &Option<Vec<Animals>>,
 ) -> AllResponses {
     info!("id: {id:?}, action: {action:?} pet: {pet:?}");
     let response: AllResponses = match id {

catalyst-gateway/bin/src/service/api/test_endpoints/test_post.rs

@@ -1,15 +1,18 @@
 //! Test validation of a json body of a POST Endpoint.
 
 use poem_extensions::{response, UniResponse::T204};
+use tracing::info;
 
 use crate::service::common::responses::{
     resp_2xx::NoContent,
+    resp_4xx::ApiValidationError,
     resp_5xx::{ServerError, ServiceUnavailable},
 };
 
 /// All responses
 pub(crate) type AllResponses = response! {
     204: NoContent,
+    400: ApiValidationError,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -27,11 +30,15 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 204 No Content - Service is OK and can keep running.
+/// * 400 API Validation Error.
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is possibly not running reliably.
 #[allow(clippy::unused_async)]
-pub(crate) async fn endpoint() -> AllResponses {
-    // otherwise everything seems to be A-OK
-    T204(NoContent)
+pub(crate) async fn endpoint(id: i32, action: &String) -> AllResponses {
+    let response: AllResponses = {
+        info!("id: {id:?}, action: {action:?}");
+        T204(NoContent)
+    };
+    response
 }

catalyst-gateway/bin/src/service/api/v0/mod.rs

@@ -21,11 +21,15 @@ pub(crate) struct V0Api;
 #[OpenApi(prefix_path = "/v0", tag = "ApiTags::V0")]
 impl V0Api {
     /// Posts a signed transaction.
+    ///
+    /// Post a signed transaction in a form of message to the network.
     #[oai(path = "/message", method = "post", operation_id = "Message")]
     async fn message_post(&self, message: Binary<Vec<u8>>) -> message_post::AllResponses {
         message_post::endpoint(message).await
     }
 
+    /// Get all active vote plans endpoint.
+    ///
     /// Get all active vote plans endpoint.
     #[oai(
         path = "/vote/active/plans",

catalyst-gateway/bin/src/service/api/v0/plans_get.rs

@@ -11,6 +11,7 @@ use crate::{
         objects::vote_plan::VotePlan,
         responses::{
             resp_2xx::OK,
+            resp_4xx::BadRequest,
             resp_5xx::{ServerError, ServiceUnavailable},
         },
     },
@@ -20,6 +21,7 @@ use crate::{
 /// All responses
 pub(crate) type AllResponses = response! {
     200: OK<Json<Vec<VotePlan>>>,
+    400: BadRequest<Json<Vec<VotePlan>>>,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -31,6 +33,8 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 200 with a JSON array with the list of vote plans with their respective data.
+/// * 400 Bad request with a JSON array with the list of vote plans with their respective
+///   data.
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service has not started, do not send other requests.

catalyst-gateway/bin/src/service/api/v1/account_votes_get.rs

@@ -2,15 +2,16 @@
 
 use std::sync::Arc;
 
-use poem::web::{Data, Path};
+use poem::web::Data;
 use poem_extensions::{response, UniResponse::T200};
-use poem_openapi::payload::Json;
+use poem_openapi::{param::Path, payload::Json};
 
 use crate::{
     service::common::{
         objects::account_votes::{AccountId, AccountVote},
         responses::{
             resp_2xx::OK,
+            resp_4xx::BadRequest,
             resp_5xx::{ServerError, ServiceUnavailable},
         },
     },
@@ -20,6 +21,7 @@ use crate::{
 /// All responses
 pub(crate) type AllResponses = response! {
     200: OK<Json<Vec<AccountVote>>>,
+    400: BadRequest<Json<Vec<AccountVote>>>,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -34,6 +36,7 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 200 with a JSON array of the number of voted proposals in a plan.
+/// * 400 Bad request with a JSON array of the number of voted proposals in a plan
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service has not started, do not send other requests.

catalyst-gateway/bin/src/service/api/v1/fragments_post.rs

@@ -9,13 +9,15 @@ use crate::service::common::{
     },
     responses::{
         resp_2xx::OK,
+        resp_4xx::BadRequest,
         resp_5xx::{ServerError, ServiceUnavailable},
     },
 };
 
 /// All responses
 pub(crate) type AllResponses = response! {
     200: OK<Json<FragmentsProcessingSummary>>,
+    400: BadRequest<Json<FragmentsProcessingSummary>>,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -27,6 +29,7 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 200 No Content - Service is OK and can keep running.
+/// * 400 Bad Request
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is possibly not running reliably.

catalyst-gateway/bin/src/service/api/v1/fragments_statuses.rs

@@ -6,20 +6,18 @@ use poem_extensions::{response, UniResponse::T200};
 use poem_openapi::payload::Json;
 
 use crate::service::common::{
-    objects::fragment_status::FragmentStatus,
+    objects::{fragment_status::FragmentStatus, fragments_processing_summary::FragmentId},
     responses::{
         resp_2xx::OK,
+        resp_4xx::BadRequest,
         resp_5xx::{ServerError, ServiceUnavailable},
     },
 };
 
-/// Comma-separated (no spaces in between) list of fragment IDs.
-#[derive(poem_openapi::NewType)]
-pub(crate) struct FragmentIds(String);
-
 /// All responses
 pub(crate) type AllResponses = response! {
     200: OK<Json<HashMap<String, FragmentStatus>>>,
+    400: BadRequest<Json<HashMap<String, FragmentStatus>>>,
     500: ServerError,
     503: ServiceUnavailable,
 };
@@ -31,10 +29,11 @@ pub(crate) type AllResponses = response! {
 /// ## Responses
 ///
 /// * 200 Fragments Statuses - Statuses of the fragments by id.
+/// * 400 Bad Request
 /// * 500 Server Error - If anything within this function fails unexpectedly. (Possible
 ///   but unlikely)
 /// * 503 Service Unavailable - Service is possibly not running reliably.
 #[allow(clippy::unused_async)]
-pub(crate) async fn endpoint(_fragment_ids: FragmentIds) -> AllResponses {
+pub(crate) async fn endpoint(_fragment_ids: Vec<FragmentId>) -> AllResponses {
     T200(OK(Json(HashMap::new())))
 }

catalyst-gateway/bin/src/service/api/v1/mod.rs

@@ -2,13 +2,20 @@
 
 use std::sync::Arc;
 
-use poem::web::{Data, Path};
-use poem_openapi::{param::Query, payload::Json, OpenApi};
+use poem::web::Data;
+use poem_openapi::{
+    param::{Path, Query},
+    payload::Json,
+    OpenApi,
+};
 
 use crate::{
     service::{
         common::{
-            objects::{account_votes::AccountId, fragments_batch::FragmentsBatch},
+            objects::{
+                account_votes::AccountId, fragments_batch::FragmentsBatch,
+                fragments_processing_summary::FragmentId,
+            },
             tags::ApiTags,
         },
         utilities::middleware::schema_validation::schema_version_validation,
@@ -31,10 +38,15 @@ impl V1Api {
         operation_id = "AccountVotes",
         transform = "schema_version_validation"
     )]
+
+    /// Get Account Votes
+    ///
     /// Get from all active vote plans, the index of the voted proposals
-    /// by th given account ID.
+    /// by the given account ID.
     async fn get_account_votes(
-        &self, state: Data<&Arc<State>>, account_id: Path<AccountId>,
+        &self, state: Data<&Arc<State>>,
+        /// A account ID to get the votes for.
+        account_id: Path<AccountId>,
     ) -> account_votes_get::AllResponses {
         account_votes_get::endpoint(state, account_id).await
     }
@@ -73,7 +85,9 @@ impl V1Api {
         &self,
         /// Comma-separated list of fragment ids for which the statuses will
         /// be retrieved.
-        Query(fragment_ids): Query<fragments_statuses::FragmentIds>,
+        // TODO (Blue) : https://github.com/input-output-hk/catalyst-voices/issues/239
+        #[oai(validator(max_items = "1000"))]
+        Query(fragment_ids): Query<Vec<FragmentId>>,
     ) -> fragments_statuses::AllResponses {
         fragments_statuses::endpoint(fragment_ids).await
     }