Skip to content

Feasibility of generating Signify types from Python type hints via OpenAI #4

@iFergal

Description

@iFergal

As Signify can in theory be written in any language, it would be hugely beneficial to generate Signify types from KERIA OpenAPI docs dynamically, so type updates can flow automatically to implementations.

Additionally, the KERIA OpenAPI docs are quite outdated, and contain a number of syntax errors so this would be a good reason to keep them up to date. Rather than defining the type in yaml it would be good to generate type hints which can be used to make KERIA more robust too, and programmatically generate the OpenAPI docs from those type hints.

This spike should take the IdentifierCollectionEnd, and:

  • Create type hints for any API responses
  • Programmatically use these in the OpenAPI docs
  • Generate TypeScript types in Signify-TS for any methods using this endpoint.

Note: It might be helpful to temporarily adjust specing.py to only generate OpenAPI docs for this endpoint to skip over the other syntax errors for now.

Metadata

Metadata

Labels

Type

No type

Projects

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions