Skip to content

[FEAT] Improve API documentation #35

@NeonDaniel

Description

@NeonDaniel

Objective

Endpoints inconsistently specify inputs and return parameters with Pydantic models. These should all be updated so that inputs and returns are clearly defined with clear descriptions.

Initial Implementation Requirements

  • Ensure all input and return parameters are consistent (i.e. all return lines within a method return the same schema)
  • Define Pydantic models for all input/return parameters (including descriptions, default values as appropriate)
  • Implement unit tests of input and return models for default value handling, validation, etc.

Other Considerations

  • There may be unused endpoints to deprecate
  • Example values may also be helpful (json_schema_extra.examples Brave AI Summary)

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions