fix: opan-api generator script

And some minor cleanup to make the generated openapi more usable Signed-off-by: Daniel Bluhm <dbluhm@pm.me>
hyperledger · Dec 8, 2023 · d8a6f3f · d8a6f3f
1 parent b055b78
commit d8a6f3f
Show file tree

Hide file tree

Showing 6 changed files with 1,963 additions and 594 deletions.
diff --git a/aries_cloudagent/indy/models/cred.py b/aries_cloudagent/indy/models/cred.py
@@ -2,7 +2,7 @@
 
 from typing import Mapping
 
-from marshmallow import EXCLUDE, fields
+from marshmallow import EXCLUDE, ValidationError, fields
 
 from ...messaging.models.base import BaseModel, BaseModelSchema
 from ...messaging.valid import (
@@ -52,6 +52,20 @@ class Meta:
     )
 
 
+class DictWithIndyAttrValueSchema(fields.Dict):
+    """Dict with indy attribute value schema."""
+
+    def _deserialize(self, value, attr, data, **kwargs):
+        """Deserialize dict with indy attribute value."""
+        if not isinstance(value, dict):
+            raise ValidationError("Value must be a dict.")
+
+        return {
+            k: IndyAttrValueSchema().load(v) if isinstance(v, dict) else v
+            for k, v in value.items()
+        }
+
+
 class IndyCredential(BaseModel):
     """Indy credential."""
 
@@ -115,11 +129,7 @@ class Meta:
             "example": INDY_REV_REG_ID_EXAMPLE,
         },
     )
-    values = fields.Dict(
-        keys=fields.Str(metadata={"description": "Attribute name"}),
-        values=fields.Nested(
-            IndyAttrValueSchema(), metadata={"description": "Attribute value"}
-        ),
+    values = DictWithIndyAttrValueSchema(
         required=True,
         metadata={"description": "Credential attributes"},
     )

diff --git a/aries_cloudagent/resolver/routes.py b/aries_cloudagent/resolver/routes.py
@@ -1,42 +1,4 @@
-"""Resolve did document admin routes.
-
-"/resolver/resolve/{did}": {
-"get": {
-"responses": {
-"200": {
-"schema": {
-"$ref": "#/definitions/DIDDoc"
-
-},
-"description": null
-
-}
-
-},
-"parameters": [
-
-{
-"in": "path",
-"name": "did",
-"required": true,
-"type": "string",
-"pattern": "did:([a-z]+):((?:[a-zA-Z0-9._-]*:)*[a-zA-Z0-9._-]+)",
-"description": "decentralize identifier(DID)",
-"example": "did:ted:WgWxqztrNooG92RXvxSTWv"
-
-}
-
-],
-
-"tags": [ "resolver" ],
-"summary": "Retrieve doc for requested did",
-"produces": [ "application/json" ]
-
-}
-
-}
-
-"""
+"""Resolve did document admin routes."""
 
 from aiohttp import web
 from aiohttp_apispec import docs, match_info_schema, response_schema
@@ -131,6 +93,9 @@ def post_process_routes(app: web.Application):
         {
             "name": "resolver",
             "description": "did resolver interface.",
-            "externalDocs": {"description": "Specification"},  # , "url": SPEC_URI},
+            "externalDocs": {
+                "description": "DID Resolution Specification",
+                "url": "https://www.w3.org/TR/did-core/#resolution",
+            },
         }
     )
diff --git a/aries_cloudagent/vc/routes.py b/aries_cloudagent/vc/routes.py
@@ -139,11 +139,11 @@ def post_process_routes(app: web.Application):
         app._state["swagger_dict"]["tags"] = []
     app._state["swagger_dict"]["tags"].append(
         {
-            "name": "jsonld",
-            "description": "Sign and verify json-ld data",
+            "name": "ldp-vc",
+            "description": "Issue and verify LDP VCs and VPs",
             "externalDocs": {
                 "description": "Specification",
-                "url": "https://tools.ietf.org/html/rfc7515",
+                "url": "https://www.w3.org/TR/vc-data-model/",
             },
         }
     )