Skip to content

feat: stronger openapi definitions for long running operations #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kentbull merged 3 commits into from
Mar 12, 2026
Merged

feat: stronger openapi definitions for long running operations #420

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6cdcec7
Specify OP types
Sotatek-Patrick-Vu Jun 27, 2025
13f7fca
resove review comments: add missing code for KeyStateRecord kt,nt
Sotatek-Patrick-Vu Mar 11, 2026
4e954a0
add missing commit: fix: extra fields for getRequest should be option…
Sotatek-Patrick-Vu Mar 12, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 2 additions & 11 deletions src/keria/app/agenting.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1847,15 +1847,6 @@ def on_get(req, rep):
rep.data = json.dumps(states).encode("utf-8")


exnFieldDomV1 = serdering.SerderKERI.Fields[serdering.Protocols.keri][
serdering.Vrsn_1_0
][serdering.Ilks.exn]
EXN_V_1, EXNSchema_V_1 = dataclassFromFielddom("EXN_V_1", exnFieldDomV1)
exnFieldDomV2 = serdering.SerderKERI.Fields[serdering.Protocols.keri][
serdering.Vrsn_2_0
][serdering.Ilks.exn]
EXN_V_2, EXNSchema_V_2 = dataclassFromFielddom("EXN_V_2", exnFieldDomV2)

issFieldDomV1 = serdering.SerderKERI.Fields[serdering.Protocols.keri][
serdering.Vrsn_1_0
][serdering.Ilks.iss]
Expand Down Expand Up @@ -1989,7 +1980,7 @@ def on_post(req, rep):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/OOBIOperation'

"""
agent = req.context.agent
Expand Down Expand Up @@ -2175,7 +2166,7 @@ def on_post(req, rep):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/QueryOperation'
404:
description: Identifier not found in Key event database

Expand Down
20 changes: 15 additions & 5 deletions src/keria/app/aiding.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@
from keri.db import basing
from marshmallow import fields
from marshmallow_dataclass import class_schema

from ..core import longrunning, httping
from ..utils.openapi import namedtupleToEnum, dataclassFromFielddom
from keri.core.serdering import Protocols, Vrsn_1_0, Vrsn_2_0, SerderKERI
Expand Down Expand Up @@ -653,7 +654,11 @@ def on_post(req, rep):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
oneOf:
- $ref: '#/components/schemas/GroupOperation'
- $ref: '#/components/schemas/WitnessOperation'
- $ref: '#/components/schemas/DelegationOperation'
- $ref: '#/components/schemas/DoneOperation'
400:
description: Bad request. This could be due to missing or invalid parameters.
"""
Expand Down Expand Up @@ -1026,7 +1031,12 @@ def on_post(self, req, rep, name):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
oneOf:
- $ref: '#/components/schemas/GroupOperation'
- $ref: '#/components/schemas/WitnessOperation'
- $ref: '#/components/schemas/DelegationOperation'
- $ref: '#/components/schemas/DoneOperation'
- $ref: '#/components/schemas/SubmitOperation'
400:
description: Bad request. This could be due to missing or invalid parameters.
"""
Expand Down Expand Up @@ -1606,7 +1616,7 @@ def on_post(req, rep, name, aid=None, role=None):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/EndRoleOperation'
400:
description: Bad request. This could be due to missing or invalid parameters.
404:
Expand Down Expand Up @@ -1715,7 +1725,7 @@ def on_post(req, rep, name):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/LocSchemeOperation'
400:
description: Bad request. This could be due to missing or invalid parameters.
404:
Expand Down Expand Up @@ -2011,7 +2021,7 @@ def on_post(req, rep, source):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ChallengeOperation'
"""
agent = req.context.agent

Expand Down
12 changes: 8 additions & 4 deletions src/keria/app/credentialing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ def on_post(self, req, rep, name):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/RegistryOperation'
404:
description: The requested registry is not a valid reference to an identifier.
400:
Expand Down Expand Up @@ -715,7 +715,7 @@ def on_post(req, rep):
application/json:
schema:
description: long running operation of credential processing
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/CredentialOperation'
404:
description: Malformed ACDC or iss event
"""
Expand Down Expand Up @@ -906,7 +906,7 @@ def on_post(self, req, rep, name):
content:
application/json:
schema:
$ref: '#/components/schemas/Credential'
$ref: '#/components/schemas/CredentialOperation'
400:
description: Bad request. This could be due to missing or invalid data.

Expand Down Expand Up @@ -1206,7 +1206,11 @@ def on_delete(self, req, rep, name, said):
content:
application/json+cesr:
schema:
$ref: '#/components/schemas/Operation'
oneOf:
- $ref: '#/components/schemas/GroupOperation'
- $ref: '#/components/schemas/DelegationOperation'
- $ref: '#/components/schemas/WitnessOperation'
- $ref: '#/components/schemas/DoneOperation'
400:
description: Bad request. This could be due to invalid revocation event or other invalid parameters.
404:
Expand Down
3 changes: 1 addition & 2 deletions src/keria/app/delegating.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
from keri.app import forwarding, agenting, habbing
from keri.core import coring, serdering
from keri.db import dbing

from keria.core import httping, longrunning

DELEGATION_ROUTE = "/identifiers/{name}/delegation"
Expand Down Expand Up @@ -240,7 +239,7 @@ def on_post(self, req, rep, name):
content:
application/json:
schema:
$ref: '#/components/schemas/Operation'
- $ref: '#/components/schemas/DelegatorOperation'
400:
description: Bad request. This could be due to missing or invalid parameters.
404:
Expand Down
7 changes: 4 additions & 3 deletions src/keria/app/grouping.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@

from keria.core import httping, longrunning
from keria.app import aiding, credentialing, agenting
from keria.peer import exchanging

logger = ogler.getLogger()

Expand Down Expand Up @@ -188,7 +189,7 @@ def on_post(req, rep, name):
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/GroupOperation'
400:
description: Bad request. Bad request. This could be due to missing or invalid parameters.
404:
Expand Down Expand Up @@ -314,7 +315,7 @@ class MultisigRpyEmbeds:

@dataclass
class MultisigExnEmbeds:
exn: Union["agenting.EXN_V_1", "agenting.EXN_V_2"] # type: ignore
exn: Union["exchanging.EXN_V_1", "exchanging.EXN_V_2"] # type: ignore


@dataclass
Expand Down Expand Up @@ -377,7 +378,7 @@ class ExnExnEmbeds(ExnEmbedsBase, MultisigExnEmbeds):

@dataclass
class ExnMultisig:
exn: Union["agenting.EXN_V_1", "agenting.EXN_V_2"] # type: ignore
exn: Union["exchanging.EXN_V_1", "exchanging.EXN_V_2"] # type: ignore
paths: dict
groupName: Optional[str] = field(
default=None, metadata={"marshmallow_field": fields.String(allow_none=False)}
Expand Down
11 changes: 5 additions & 6 deletions src/keria/app/ipexing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,7 @@ def on_post(req, rep, name):
content:
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ExchangeOperation'

"""
agent = req.context.agent
Expand Down Expand Up @@ -223,7 +222,7 @@ def on_post(req, rep, name):
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ExchangeOperation'

"""
agent = req.context.agent
Expand Down Expand Up @@ -383,7 +382,7 @@ def on_post(req, rep, name):
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ExchangeOperation'

"""
agent = req.context.agent
Expand Down Expand Up @@ -537,7 +536,7 @@ def on_post(req, rep, name):
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ExchangeOperation'

"""
agent = req.context.agent
Expand Down Expand Up @@ -695,7 +694,7 @@ def on_post(req, rep, name):
application/json:
schema:
type: object
$ref: '#/components/schemas/Operation'
$ref: '#/components/schemas/ExchangeOperation'

"""
agent = req.context.agent
Expand Down
Loading
Loading