some more documentation in the API and in the API code

This commit is contained in:
Laura Klünder 2023-11-19 00:12:10 +01:00
parent f96e916184
commit 0f43274e33
8 changed files with 126 additions and 24 deletions

View file

@ -3,9 +3,16 @@ from typing import Literal
from ninja import Schema
from pydantic import Field as APIField
from c3nav.api.utils import NonEmptyStr
class APIErrorSchema(Schema):
detail: str
"""
An error has occured with this request
"""
detail: NonEmptyStr = APIField(
description="A human-readable error description"
)
class PolygonSchema(Schema):