fix(API Docs): Adds in schema that isn't used b/c our API does not co…

…nform to spec.
Sefaria · Jan 11, 2024 · 0b8e5fe · 0b8e5fe
1 parent 886fe11
commit 0b8e5fe
Showing 1 changed file with 86 additions and 82 deletions.
diff --git a/static/files/openAPI.json b/static/files/openAPI.json
@@ -404,88 +404,6 @@
                 "description": "Returns a random text reference from the Sefaria library. Results can be limited to a specific category or from a selection of titles given the correct query params."
             }
         },
-        "/api/recommend/topics/{ref_list}": {
-            "get": {
-                "parameters": [
-                    {
-                        "examples": {
-                            "example1": {
-                                "value": "Genesis 50+Mishnah Peah 3"
-                            }
-                        },
-                        "name": "ref_list",
-                        "description": "List of strings separated by '+'",
-                        "schema": {
-                            "type": "string"
-                        },
-                        "in": "path",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "type": "array",
-                                    "items": {
-                                        "$ref": "#/components/schemas/recommendedTopicResponse"
-                                    }
-                                }
-                            }
-                        },
-                        "description": "Successful response"
-                    }
-                },
-                "summary": "Recommended topics API",
-                "description": "Given a list of `Ref`s this API returns the most used topics associated with them. This is a fast way of identifying potential shared topics amongst disparate `Ref`s."
-            },
-            "post": {
-                "requestBody": {
-                    "content": {
-                        "application/json": {
-                            "schema": {
-                                "type": "object",
-                                "properties": {
-                                    "json": {
-                                        "description": "List of strings",
-                                        "type": "array",
-                                        "items": {
-                                            "type": "string"
-                                        }
-                                    }
-                                }
-                            }
-                        }
-                    },
-                    "required": true
-                },
-                "parameters": [
-                    {
-                        "name": "ref_list",
-                        "in": "path",
-                        "required": true
-                    }
-                ],
-                "responses": {
-                    "200": {
-                        "content": {
-                            "application/json": {
-                                "schema": {
-                                    "type": "array",
-                                    "items": {
-                                        "$ref": "#/components/schemas/recommendedTopicResponse"
-                                    }
-                                }
-                            }
-                        },
-                        "description": "Successful response"
-                    }
-                },
-                "summary": "Recommended topics API",
-                "description": "Given a list of refs this API returns the most used topics associated with them. It's a fast way of identifying potential shared topics amongst disperate references.\n\nn.b. The `ref_list` param is not required for a post request."
-            }
-        },
         "/api/manuscripts/{tref}": {
             "summary": "For a given `tref` (textual ref), if a manuscript exists, returns a list of all relevant data as well as the image URL for each associated manuscript.",
             "get": {
@@ -4934,6 +4852,92 @@
                     "required": true
                 }
             ]
+        },
+        "/api/recommend/topics/{ref_list}": {
+            "get": {
+                "parameters": [
+                    {
+                        "examples": {
+                            "example1": {
+                                "value": "Genesis 50+Mishnah Peah 3"
+                            }
+                        },
+                        "name": "ref_list",
+                        "description": "List of strings separated by '+'",
+                        "schema": {
+                            "type": "string"
+                        },
+                        "in": "path",
+                        "required": true
+                    }
+                ],
+                "responses": {
+                    "200": {
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/recommendedTopicResponse"
+                                    }
+                                }
+                            }
+                        },
+                        "description": "Successful response"
+                    }
+                },
+                "summary": "Recommended topics API",
+                "description": "Given a list of `Ref`s this API returns the most used topics associated with them. This is a fast way of identifying potential shared topics amongst disparate `Ref`s."
+            },
+            "post": {
+                "requestBody": {
+                    "content": {
+                        "application/json": {
+                            "schema": {
+                                "type": "object",
+                                "properties": {
+                                    "json": {
+                                        "description": "List of strings",
+                                        "type": "array",
+                                        "items": {
+                                            "type": "string"
+                                        }
+                                    }
+                                }
+                            }
+                        }
+                    },
+                    "required": true
+                },
+                "responses": {
+                    "200": {
+                        "content": {
+                            "application/json": {
+                                "schema": {
+                                    "type": "array",
+                                    "items": {
+                                        "$ref": "#/components/schemas/recommendedTopicResponse"
+                                    }
+                                }
+                            }
+                        },
+                        "description": "Successful response"
+                    }
+                },
+                "summary": "Recommended topics API",
+                "description": "Given a list of refs this API returns the most used topics associated with them. It's a fast way of identifying potential shared topics amongst disperate references.\n\nn.b. The `ref_list` param is not required for a post request."
+            },
+            "parameters": [
+                {
+                    "name": "ref_list",
+                    "description": "List of strings separated by '+'",
+                    "schema": {
+                        "type": "string"
+                    },
+                    "in": "path",
+                    "required": true
+                }
+            ]
         }
     },
     "components": {