Skip to content

Provide doc page(s) for our common model errors from Pydantic #162

@tomschr

Description

@tomschr

Affected Documentation Section

New Error topic, related to #158.

Suggested Change

When Pydantic find a validation error, it gives you this message:

For further information visit https://errors.pydantic.dev/2.12/v/extra_forbidden

There you can find additional information.

I think this is a great idea to provide more information. When you run docbuild and get a bunch of error messages, it may be overwhelming. Providing a link which gives you the reason and a solution may be a way to deal with this.

Additional Context

Some idea that needs to be discussed:

  • Each error should be stored in a separate page.
    Although the page may be small, it helps to make it visually more readable and accessible.
  • Each error page should follow the same structure:
    • name of the error
    • Culprit
    • Solution
  • Maybe create a top-level "errors" directory besides developer and reference.

Metadata

Metadata

Assignees

No one assigned

    Labels

    area:documentationImprovements or additions to documentation

    Type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions