Sync fastapi docs from b5ca1324 on 2025-12-07

tests/test_tutorial/test_openapi_webhooks/test_tutorial001.py

@@ -0,0 +1,117 @@
+from fastapi.testclient import TestClient
+
+from docs_src.openapi_webhooks.tutorial001 import app
+
+client = TestClient(app)
+
+
+def test_get():
+    response = client.get("/users/")
+    assert response.status_code == 200, response.text
+    assert response.json() == ["Rick", "Morty"]
+
+
+def test_dummy_webhook():
+    # Just for coverage
+    app.webhooks.routes[0].endpoint({})
+
+
+def test_openapi_schema():
+    response = client.get("/openapi.json")
+    assert response.status_code == 200, response.text
+    assert response.json() == {
+        "openapi": "3.1.0",
+        "info": {"title": "FastAPI", "version": "0.1.0"},
+        "paths": {
+            "/users/": {
+                "get": {
+                    "summary": "Read Users",
+                    "operationId": "read_users_users__get",
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        }
+                    },
+                }
+            }
+        },
+        "webhooks": {
+            "new-subscription": {
+                "post": {
+                    "summary": "New Subscription",
+                    "description": "When a new user subscribes to your service we'll send you a POST request with this\ndata to the URL that you register for the event `new-subscription` in the dashboard.",
+                    "operationId": "new_subscriptionnew_subscription_post",
+                    "requestBody": {
+                        "content": {
+                            "application/json": {
+                                "schema": {"$ref": "#/components/schemas/Subscription"}
+                            }
+                        },
+                        "required": True,
+                    },
+                    "responses": {
+                        "200": {
+                            "description": "Successful Response",
+                            "content": {"application/json": {"schema": {}}},
+                        },
+                        "422": {
+                            "description": "Validation Error",
+                            "content": {
+                                "application/json": {
+                                    "schema": {
+                                        "$ref": "#/components/schemas/HTTPValidationError"
+                                    }
+                                }
+                            },
+                        },
+                    },
+                }
+            }
+        },
+        "components": {
+            "schemas": {
+                "HTTPValidationError": {
+                    "properties": {
+                        "detail": {
+                            "items": {"$ref": "#/components/schemas/ValidationError"},
+                            "type": "array",
+                            "title": "Detail",
+                        }
+                    },
+                    "type": "object",
+                    "title": "HTTPValidationError",
+                },
+                "Subscription": {
+                    "properties": {
+                        "username": {"type": "string", "title": "Username"},
+                        "monthly_fee": {"type": "number", "title": "Monthly Fee"},
+                        "start_date": {
+                            "type": "string",
+                            "format": "date-time",
+                            "title": "Start Date",
+                        },
+                    },
+                    "type": "object",
+                    "required": ["username", "monthly_fee", "start_date"],
+                    "title": "Subscription",
+                },
+                "ValidationError": {
+                    "properties": {
+                        "loc": {
+                            "items": {
+                                "anyOf": [{"type": "string"}, {"type": "integer"}]
+                            },
+                            "type": "array",
+                            "title": "Location",
+                        },
+                        "msg": {"type": "string", "title": "Message"},
+                        "type": {"type": "string", "title": "Error Type"},
+                    },
+                    "type": "object",
+                    "required": ["loc", "msg", "type"],
+                    "title": "ValidationError",
+                },
+            }
+        },
+    }