feature(common, openapi): deprecate signer_registration_protocol_parameters and cardano_transactions_signing_config for EpochSettingsMessage

Author: turmelclem

mithril-common/src/messages/epoch_settings.rs

@@ -9,6 +9,7 @@ pub struct EpochSettingsMessage {
     pub epoch: Epoch,
 
     /// Signer Registration Protocol parameters
+    #[deprecated]
     #[serde(rename = "signer_registration_protocol")]
     pub signer_registration_protocol_parameters: ProtocolParameters,
 
@@ -19,6 +20,7 @@ pub struct EpochSettingsMessage {
     pub next_signers: Vec<SignerMessagePart>,
 
     /// Cardano transactions signing configuration for the current epoch
+    #[deprecated]
     #[serde(skip_serializing_if = "Option::is_none")]
     pub cardano_transactions_signing_config: Option<CardanoTransactionsSigningConfig>,
 }

openapi.yaml

@@ -83,12 +83,10 @@ paths:
       summary: Get current epoch settings
       description: |
         Returns the information related to the current epoch:
-          * protocol parameters for current epoch
-          * protocol parameters for next epoch (to setup cryptography, allowing signers to register)
+          * (deprecated) protocol parameters for next epoch (to setup cryptography, allowing signers to register)
           * signers for current epoch
           * signers for next epoch
-          * cardano transactions signing configuration for current epoch
-          * cardano transactions signing configuration for next epoch
+          * (deprecated) cardano transactions signing configuration for current epoch
       responses:
         "200":
           description: epoch settings found
@@ -998,6 +996,7 @@ components:
           $ref: "#/components/schemas/Epoch"
         signer_registration_protocol:
           $ref: "#/components/schemas/ProtocolParameters"
+          deprecated: true
         current_signers:
           type: array
           items:
@@ -1008,6 +1007,7 @@ components:
             $ref: "#/components/schemas/Signer"
         cardano_transactions_signing_config:
           $ref: "#/components/schemas/CardanoTransactionsSigningConfig"
+          deprecated: true
       examples:
         - {
             "epoch": 329,