Skip to content

Return type annotations in core_api #93

Description

@SeijDeLeon

A nice feature for the rest api would be if there were return types in the endpoints that could be used to help auto-generate api calls for a frontend. The openapi.json doc (avilable at (http://localhost:60610/openapi.json) holds info that can be used to do auto generation of frontend api calls using tools like https://www.npmjs.com/package/openapi-typescript however the endpoints don't include a return type, so this kind of utility has limited use.

Currently I have just made requests manually and recorded the responses as examples, but adding clear return types in the endpoints could help people to auto generate their own api client systems for use in their web apps.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions