Update OpenAPI specs

And update the MITHRIL_API_VERSION accordingly.

Author: jpraynaud

mithril-common/src/lib.rs

@@ -42,4 +42,4 @@ pub const SIGNER_EPOCH_RECORDING_OFFSET: i64 = 1;
 /// this is the same as the one in openapi.yml file.
 /// If you want to update this version to reflect changes in the protocol,
 /// please also update the entry in the openapi.yml
-pub const MITHRIL_API_VERSION: &str = "0.0.1";
+pub const MITHRIL_API_VERSION: &str = "0.1.0";

openapi.yaml

@@ -4,7 +4,7 @@ info:
   # `mithril-aggregator/src/http_server/mod.rs` file. If you plan to update it
   # here to reflect changes in the API, please also update the constant in the
   # Rust file.
-  version: 0.0.1
+  version: 0.1.0
   title: Mithril Aggregator Server
   description: |
     The REST API provided by a Mithril Aggregator Node in a Mithril network.
@@ -28,7 +28,8 @@ paths:
       summary: Get current epoch settings
       description: |
         Returns the information related to the current epoch:
-          * protocol parameters for current epoch (to setup cryptography, allowing signers to register)
+          * protocol parameters for current epoch
+          * protocol parameters for next epoch (to setup cryptography, allowing signers to register)
       responses:
         "200":
           description: epoch settings found
@@ -238,17 +239,21 @@ components:
       required:
         - epoch
         - protocol
+        - next_protocol
       properties:
         epoch:
           description: Cardano chain epoch number
           type: integer
           format: int64
         protocol:
           $ref: "#/components/schemas/ProtocolParameters"
+        next_protocol:
+          $ref: "#/components/schemas/ProtocolParameters"
       example: 
         { 
           "epoch": 329,
-          "protocol": { "k": 857, "m": 6172, "phi_f": 0.2 }
+          "protocol": { "k": 857, "m": 6172, "phi_f": 0.2 },
+          "next_protocol": { "k": 2422, "m": 20973, "phi_f": 0.2 }
         }
     ProtocolParameters:
       description: Protocol cryptographic parameters