Bump version and docs to v2.9.0

CardanoSolutions · Jul 19, 2024 · a6908b5 · a6908b5
1 parent 17367b9
commit a6908b5
Show file tree

Hide file tree

Showing 6 changed files with 94 additions and 27 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,12 +1,21 @@
-
-### [2.9.0] - UNRELEASED
+### [2.9.0] - 2024-07-19
 
 #### Added
 
+- Integrate with `cardano-node==9.0.0`.
+
 - Compatibility with hydra-node 0.16.0.
 
 - `tip` is now supported as a value for the `--since` option. When provided, the indexing process will start wherever the blockchain source (node, ogmios, ...) is at.
 
+#### Changed
+
+N/A
+
+#### Removed
+
+N/A
+
 ### [2.8.0] - 2024-02-09
 
 #### Added

diff --git a/docs/api/latest.yaml → docs/api/nightly.yaml b/docs/api/latest.yaml → docs/api/nightly.yaml
@@ -159,6 +159,10 @@ info:
     [#era-boundaries] which references points at which era ends for mainnet and
     testnet; useful to start syncing from a specific era.
 
+    > <sup><strong>TIP</strong></sup> <br/>
+    > If you just want to start synchronize from _now_, you can pass simply
+    > pass <code>tip</code> as a value (i.e. `--since tip`).
+
     ## --match {pattern}
 
     Kupo can accept one or more matching patterns using the `--match` option.

diff --git a/docs/api/v2.7.2.yaml → docs/api/v2.9.0.yaml b/docs/api/v2.7.2.yaml → docs/api/v2.9.0.yaml
@@ -5,7 +5,7 @@ servers:
 
 info:
   title: Kupo
-  version: v2.7.2
+  version: v2.9.0
   license:
     name: MPL-2.0
     url: https://raw.githubusercontent.com/cardanosolutions/kupo/master/LICENSE
@@ -159,6 +159,10 @@ info:
     [#era-boundaries] which references points at which era ends for mainnet and
     testnet; useful to start syncing from a specific era.
 
+    > <sup><strong>TIP</strong></sup> <br/>
+    > If you just want to start synchronize from _now_, you can pass simply
+    > pass <code>tip</code> as a value (i.e. `--since tip`).
+
     ## --match {pattern}
 
     Kupo can accept one or more matching patterns using the `--match` option.
@@ -1277,6 +1281,7 @@ components:
         - connection_status
         - most_recent_checkpoint
         - most_recent_node_tip
+        - configuration
         - version
       properties:
         connection_status:
@@ -1297,10 +1302,46 @@ components:
               description: Absolute slot number of the current tip of the node.
             - type: "null"
               description: Absolute slot number of the current tip of the node.
+        configuration:
+          type: object
+          description: A summary of hand-picked configuration parameters.
+          additionalProperties: false
+          required:
+            - indexes
+          properties:
+            indexes:
+              type: string
+              description: Behaviour surrounding the database query indexes.
+              enum:
+                - deferred
+                - installed
         version:
           type: string
           description: Current software version.
 
+    HealthPrometheus:
+      type: string
+      description: |
+        A key-value export compatible with Prometheus.
+
+        - `connected` and `disconnected` (from `connection_status`) are encoded as `1.0` and `0.0` respectively.
+        - `installed` and `deferred` (from `configuration.indexes`) are encoded as `1.0` and `0.0` respectively.
+        - `version` is not present in the Prometheus metrics.
+      examples:
+        response:
+          value: |
+            # TYPE kupo_connection_status gauge
+            kupo_connection_status  1.0
+
+            # TYPE kupo_most_recent_checkpoint counter
+            kupo_most_recent_checkpoint  294998
+
+            # TYPE kupo_most_recent_node_tip counter
+            kupo_most_recent_node_tip  71753381
+
+            # TYPE kupo_configuration_indexes gauge
+            kupo_configuration_indexes  1.0
+
   parameters:
     asset-name:
       name: asset_name
@@ -2082,9 +2123,38 @@ paths:
         Retrieve Kupo's application health status. Note that this call is cheap and does not halt the various concurrent tasks performed by the Kupo.
 
         This endpoint has two possible content-types: `application/json` or `text/plain`. The latter returns health in a format suitable for [Prometheus](https://prometheus.io/docs/introduction/overview/). The server defaults to `application/json`, but you can control this behavior by passing a corresponding `Accept` header.
+
+        In addition, the server may return any of the following response codes:
+        - 200: when healthy
+        - 202: when connected to a chain producer but still syncing
+        - 503: when disconnected from a chain producer
       responses:
         200:
-          description: OK
+          description: Healthy
+          headers: *default-headers
+          content:
+            "application/json;charset=utf-8":
+              schema:
+                $ref: "#/components/schemas/Health"
+
+            "text/plain;charset=utf-8":
+              schema:
+                $ref: "#/components/schemas/HealthPrometheus"
+
+        202:
+          description: Syncing
+          headers: *default-headers
+          content:
+            "application/json;charset=utf-8":
+              schema:
+                $ref: "#/components/schemas/Health"
+
+            "text/plain;charset=utf-8":
+              schema:
+                $ref: "#/components/schemas/HealthPrometheus"
+
+        503:
+          description: Unavailable
           headers: *default-headers
           content:
             "application/json;charset=utf-8":
@@ -2093,20 +2163,4 @@ paths:
 
             "text/plain;charset=utf-8":
               schema:
-                type: string
-                description: |
-                  A key-value export compatible with Prometheus.
-
-                  - `connected` and `disconnected` are encoded as `1.0` and `0.0` respectively.
-                  - `version` is not present in the Prometheus metrics.
-              examples:
-                response:
-                  value: |
-                    # TYPE kupo_connection_status gauge
-                    kupo_connection_status  1.0
-
-                    # TYPE kupo_most_recent_checkpoint counter
-                    kupo_most_recent_checkpoint  294998
-
-                    # TYPE kupo_most_recent_node_tip counter
-                    kupo_most_recent_node_tip  71753381
+                $ref: "#/components/schemas/HealthPrometheus"
diff --git a/docs/index.html b/docs/index.html
@@ -126,8 +126,8 @@
   </script>
 
   <div id="versions">
-    <a href="#">v2.7.2</a>
     <a href="#">v2.8.0</a>
+    <a href="#">v2.9.0</a>
     <a href="#">nightly</a>
     <script>
       ;[1,2,3].forEach(ix => {
@@ -142,6 +142,6 @@
 
   <redoc id="redoc-container"></redoc>
   <script src="https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.js"></script>
-  <script>render('latest');</script>
+  <script>render('nightly');</script>
 </body>
 </html>
diff --git a/kupo.cabal b/kupo.cabal
diff --git a/package.yaml b/package.yaml
@@ -1,7 +1,7 @@
 _config: !include ".hpack.config.yaml"
 
 name:                kupo
-version:             0
+version:             2.9.0
 stability:           stable
 github:              "cardanosolutions/kupo"
 license:             MPL-2.0