Merge branch 'release/24.01.1'

graphsense · Jan 25, 2024 · 48a5821 · 48a5821
2 parents 48fc49c + 8620560
commit 48a5821
Show file tree

Hide file tree

Showing 40 changed files with 67,445 additions and 4,823 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [24.01.0] - 2024-01-25
+
+### Fixed
+- patched documentation
+
 ## [24.01.0] - 2024-01-10
 
 ### Added

diff --git a/Makefile b/Makefile
@@ -28,14 +28,13 @@ drop-integration-db:
 generate-openapi-server:
 	docker run --rm   \
 		-v "${PWD}:/build:Z" \
-		-v "${PWD}/openapi_server/openapi/openapi.yaml:/spec.yaml" \
 		-v "${PWD}/templates:/templates" \
 		openapitools/openapi-generator-cli:v5.2.1 \
-		generate -i /spec.yaml \
+		generate -i "https://raw.githubusercontent.com/graphsense/graphsense-openapi/v$(GS_OPENAPI_VERSION)/graphsense.yaml" \
 		-g python-aiohttp \
 		-o /build \
 		-t /templates \
-		--additional-properties=packageVersion=$(RELEASE)
+		--additional-properties=packageVersion=$(GS_REST_SERVICE_VERSION)
 
 
 get-openapi-spec-from-upstream:

diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@ The GraphSense REST Interface provides access to denormalized views computed
 by the [graphsense-transformation][graphsense-transformation] pipeline.
 It is used by the [graphsense-dashboard][graphsense-dashboard] component.
 
-It is based on a server stub generated by the [OpenAPI Generator][openapi-generator] project against the [graphsense-openapi][graphsense-openapi] specification version 1.4.0.
+It is based on a server stub generated by the [OpenAPI Generator][openapi-generator] project against the [graphsense-openapi][graphsense-openapi] specification version 1.4.2.
 It uses the [Connexion][connexion] library on top of [aiohttp][aiohttp].
 
 *Note:* This `README.md` is also generated. Changes must be made in

diff --git a/openapi_server/controllers/tokens_controller.py b/openapi_server/controllers/tokens_controller.py
@@ -13,7 +13,7 @@
 
 
 async def list_supported_tokens(request: web.Request, currency) -> web.Response:
-    """Returns a list of supported token (sub)currencies.
+    """Returns a list of supported token (sub)currencies
 
     
 

diff --git a/openapi_server/controllers/txs_controller.py b/openapi_server/controllers/txs_controller.py
@@ -160,7 +160,7 @@ async def get_spent_in_txs(request: web.Request, currency, tx_hash, io_index=Non
 
 
 async def get_tx(request: web.Request, currency, tx_hash, include_io=None, token_tx_id=None) -> web.Response:
-    """Returns details of a specific transaction identified by its hash.
+    """Returns details of a specific transaction identified by its hash
 
     
 
@@ -234,7 +234,7 @@ async def get_tx(request: web.Request, currency, tx_hash, include_io=None, token
 
 
 async def get_tx_io(request: web.Request, currency, tx_hash, io) -> web.Response:
-    """Returns input/output values of a specific transaction identified by its hash.
+    """Returns input/output values of a specific transaction identified by its hash
 
     
 

diff --git a/openapi_server/models/actor.py b/openapi_server/models/actor.py
@@ -16,44 +16,44 @@ class Actor(Model):
     Do not edit the class manually.
     """
 
-    def __init__(self, categories: List[LabeledItemRef]=None, context: ActorContext=None, id: str=None, jurisdictions: List[LabeledItemRef]=None, label: str=None, nr_tags: int=None, uri: str=None):
+    def __init__(self, id: str=None, label: str=None, uri: str=None, nr_tags: int=None, categories: List[LabeledItemRef]=None, jurisdictions: List[LabeledItemRef]=None, context: ActorContext=None):
         """Actor - a model defined in OpenAPI
 
-        :param categories: The categories of this Actor.
-        :param context: The context of this Actor.
         :param id: The id of this Actor.
-        :param jurisdictions: The jurisdictions of this Actor.
         :param label: The label of this Actor.
-        :param nr_tags: The nr_tags of this Actor.
         :param uri: The uri of this Actor.
+        :param nr_tags: The nr_tags of this Actor.
+        :param categories: The categories of this Actor.
+        :param jurisdictions: The jurisdictions of this Actor.
+        :param context: The context of this Actor.
         """
         self.openapi_types = {
-            'categories': List[LabeledItemRef],
-            'context': ActorContext,
             'id': str,
-            'jurisdictions': List[LabeledItemRef],
             'label': str,
+            'uri': str,
             'nr_tags': int,
-            'uri': str
+            'categories': List[LabeledItemRef],
+            'jurisdictions': List[LabeledItemRef],
+            'context': ActorContext
         }
 
         self.attribute_map = {
-            'categories': 'categories',
-            'context': 'context',
             'id': 'id',
-            'jurisdictions': 'jurisdictions',
             'label': 'label',
+            'uri': 'uri',
             'nr_tags': 'nr_tags',
-            'uri': 'uri'
+            'categories': 'categories',
+            'jurisdictions': 'jurisdictions',
+            'context': 'context'
         }
 
-        self._categories = categories
-        self._context = context
         self._id = id
-        self._jurisdictions = jurisdictions
         self._label = label
-        self._nr_tags = nr_tags
         self._uri = uri
+        self._nr_tags = nr_tags
+        self._categories = categories
+        self._jurisdictions = jurisdictions
+        self._context = context
 
     @classmethod
     def from_dict(cls, dikt: dict) -> 'Actor':
@@ -72,60 +72,14 @@ def to_dict(self, shallow=False):
         """
         if not shallow:
             return Model.to_dict(self)
-        return { 'categories': self._categories,
-            'context': self._context,
-            'id': self._id,
-            'jurisdictions': self._jurisdictions,
+        return { 'id': self._id,
             'label': self._label,
+            'uri': self._uri,
             'nr_tags': self._nr_tags,
-            'uri': self._uri }
-
-
-    @property
-    def categories(self):
-        """Gets the categories of this Actor.
-
-        A list actor categories
-
-        :return: The categories of this Actor.
-        :rtype: List[LabeledItemRef]
-        """
-        return self._categories
-
-    @categories.setter
-    def categories(self, categories):
-        """Sets the categories of this Actor.
-
-        A list actor categories
-
-        :param categories: The categories of this Actor.
-        :type categories: List[LabeledItemRef]
-        """
-        if categories is None:
-            raise BadUserInputException("Invalid value for `categories`, must not be `None`")
-
-        self._categories = categories
-
-    @property
-    def context(self):
-        """Gets the context of this Actor.
-
-
-        :return: The context of this Actor.
-        :rtype: ActorContext
-        """
-        return self._context
-
-    @context.setter
-    def context(self, context):
-        """Sets the context of this Actor.
-
-
-        :param context: The context of this Actor.
-        :type context: ActorContext
-        """
+            'categories': self._categories,
+            'jurisdictions': self._jurisdictions,
+            'context': self._context }
 
-        self._context = context
 
     @property
     def id(self):
@@ -152,31 +106,6 @@ def id(self, id):
 
         self._id = id
 
-    @property
-    def jurisdictions(self):
-        """Gets the jurisdictions of this Actor.
-
-        A list jurisdictions
-
-        :return: The jurisdictions of this Actor.
-        :rtype: List[LabeledItemRef]
-        """
-        return self._jurisdictions
-
-    @jurisdictions.setter
-    def jurisdictions(self, jurisdictions):
-        """Sets the jurisdictions of this Actor.
-
-        A list jurisdictions
-
-        :param jurisdictions: The jurisdictions of this Actor.
-        :type jurisdictions: List[LabeledItemRef]
-        """
-        if jurisdictions is None:
-            raise BadUserInputException("Invalid value for `jurisdictions`, must not be `None`")
-
-        self._jurisdictions = jurisdictions
-
     @property
     def label(self):
         """Gets the label of this Actor.
@@ -202,6 +131,31 @@ def label(self, label):
 
         self._label = label
 
+    @property
+    def uri(self):
+        """Gets the uri of this Actor.
+
+        URI
+
+        :return: The uri of this Actor.
+        :rtype: str
+        """
+        return self._uri
+
+    @uri.setter
+    def uri(self, uri):
+        """Sets the uri of this Actor.
+
+        URI
+
+        :param uri: The uri of this Actor.
+        :type uri: str
+        """
+        if uri is None:
+            raise BadUserInputException("Invalid value for `uri`, must not be `None`")
+
+        self._uri = uri
+
     @property
     def nr_tags(self):
         """Gets the nr_tags of this Actor.
@@ -226,26 +180,72 @@ def nr_tags(self, nr_tags):
         self._nr_tags = nr_tags
 
     @property
-    def uri(self):
-        """Gets the uri of this Actor.
+    def categories(self):
+        """Gets the categories of this Actor.
 
-        URI
+        A list actor categories
 
-        :return: The uri of this Actor.
-        :rtype: str
+        :return: The categories of this Actor.
+        :rtype: List[LabeledItemRef]
         """
-        return self._uri
+        return self._categories
 
-    @uri.setter
-    def uri(self, uri):
-        """Sets the uri of this Actor.
+    @categories.setter
+    def categories(self, categories):
+        """Sets the categories of this Actor.
 
-        URI
+        A list actor categories
 
-        :param uri: The uri of this Actor.
-        :type uri: str
+        :param categories: The categories of this Actor.
+        :type categories: List[LabeledItemRef]
         """
-        if uri is None:
-            raise BadUserInputException("Invalid value for `uri`, must not be `None`")
+        if categories is None:
+            raise BadUserInputException("Invalid value for `categories`, must not be `None`")
 
-        self._uri = uri
+        self._categories = categories
+
+    @property
+    def jurisdictions(self):
+        """Gets the jurisdictions of this Actor.
+
+        A list jurisdictions
+
+        :return: The jurisdictions of this Actor.
+        :rtype: List[LabeledItemRef]
+        """
+        return self._jurisdictions
+
+    @jurisdictions.setter
+    def jurisdictions(self, jurisdictions):
+        """Sets the jurisdictions of this Actor.
+
+        A list jurisdictions
+
+        :param jurisdictions: The jurisdictions of this Actor.
+        :type jurisdictions: List[LabeledItemRef]
+        """
+        if jurisdictions is None:
+            raise BadUserInputException("Invalid value for `jurisdictions`, must not be `None`")
+
+        self._jurisdictions = jurisdictions
+
+    @property
+    def context(self):
+        """Gets the context of this Actor.
+
+
+        :return: The context of this Actor.
+        :rtype: ActorContext
+        """
+        return self._context
+
+    @context.setter
+    def context(self, context):
+        """Sets the context of this Actor.
+
+
+        :param context: The context of this Actor.
+        :type context: ActorContext
+        """
+
+        self._context = context