fix: repair how multiple examples are declared in web_api (#243)

Before fastapi 0.99, we could declare multiple examples with examples=[{"key1": ..., "key2": ...}] Now, examples no longer accept keys or metadata, just a list of plain examples. Since fastapi 0.103, using openapi_examples instead restores the old key and metadata functionality. See https://fastapi.tiangolo.com/tutorial/schema-extra-example/#using-the-openapi_examples-parameter for details.
ReadAlongs · Oct 3, 2024 · eec5662 · eec5662
1 parent 1738c15
commit eec5662
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 22 deletions.
diff --git a/readalongs/web_api.py b/readalongs/web_api.py
@@ -145,28 +145,26 @@ async def langs() -> List[SupportedLanguage]:
 @v1.post("/assemble", response_model=AssembleResponse)
 async def assemble(
     request: AssembleRequest = Body(
-        examples=[
-            {
-                "text": {
-                    "summary": "A basic example with plain text input",
-                    "value": {
-                        "input": "hej verden",
-                        "type": "text/plain",
-                        "text_languages": ["dan", "und"],
-                        "debug": False,
-                    },
+        openapi_examples={
+            "text": {
+                "summary": "A basic example with plain text input",
+                "value": {
+                    "input": "hej verden",
+                    "type": "text/plain",
+                    "text_languages": ["dan", "und"],
+                    "debug": False,
                 },
-                "xml": {
-                    "summary": "A basic example with xml input",
-                    "value": {
-                        "input": "<?xml version='1.0' encoding='utf-8'?><read-along version=\"1.0\"><text><p><s>hej verden</s></p></text></read-along>",
-                        "type": "application/readalong+xml",
-                        "text_languages": ["dan", "und"],
-                        "debug": False,
-                    },
+            },
+            "xml": {
+                "summary": "A basic example with xml input",
+                "value": {
+                    "input": "<?xml version='1.0' encoding='utf-8'?><read-along version=\"1.0\"><text><p><s>hej verden</s></p></text></read-along>",
+                    "type": "application/readalong+xml",
+                    "text_languages": ["dan", "und"],
+                    "debug": False,
                 },
-            }
-        ]
+            },
+        }
     ),
 ):
     """Create an input RAS from the given text (as plain text or XML).
@@ -331,7 +329,7 @@ class ConvertRequest(BaseModel):
                 """\
                 <?xml version='1.0' encoding='utf-8'?>
                 <read-along version="%s">
-    <meta name="generator" content="@readalongs/studio (cli) %s"/>
+                    <meta name="generator" content="@readalongs/studio (cli) %s"/>
                     <text xml:lang="dan" fallback-langs="und" id="t0">
                         <body id="t0b0">
                             <div type="page" id="t0b0d0">

diff --git a/requirements.min.txt b/requirements.min.txt
@@ -2,7 +2,7 @@
 chevron==0.14.0
 click>=8.0.4
 coloredlogs>=10.0
-fastapi>=0.100.0
+fastapi>=0.103.0
 g2p>=1.1.20230822, <3
 lxml==4.9.4
 numpy>=1.20.2