From db238f2f9a8cf37471479834db5ed7fb80f5dba7 Mon Sep 17 00:00:00 2001
From: natsuki ueda <biafrajr@gmail.com>
Date: Tue, 4 Feb 2025 13:28:04 +0900
Subject: [PATCH 1/2] add in faq

---
 docs/guide/faq.md                          | 33 ++++++++--------------
 docs/snippets/guide/faq/dummy_class_an.php | 21 ++++++++++++++
 docs/snippets/guide/faq/dummy_class_at.php | 18 ++++++++++++
 3 files changed, 51 insertions(+), 21 deletions(-)
 create mode 100644 docs/snippets/guide/faq/dummy_class_an.php
 create mode 100644 docs/snippets/guide/faq/dummy_class_at.php

diff --git a/docs/guide/faq.md b/docs/guide/faq.md
index 87bf9d962..37fcc92dd 100644
--- a/docs/guide/faq.md
+++ b/docs/guide/faq.md
@@ -24,27 +24,18 @@ related code, the info annotation (and a few more) is kind of global.
 The simplest solution to avoid this issue is to add a 'dummy' class to the docblock and add
 all 'global' annotations (e.g. `Tag`, `Server`, `SecurityScheme`, etc.) **in a single docblock** to that class.
 
-```php
-/**
- * @OA\Tag(
- *     name="user",
- *     description="User related operations"
- * )
- * @OA\Info(
- *     version="1.0",
- *     title="Example API",
- *     description="Example info",
- *     @OA\Contact(name="Swagger API Team")
- * )
- * @OA\Server(
- *     url="https://example.localhost",
- *     description="API server"
- * )
- */
-class OpenApiSpec
-{
-}
-```
+<codeblock id="dummy-class">
+  <template v-slot:at>
+
+<<< @/snippets/guide/faq/dummy_class_at.php
+
+  </template>
+  <template v-slot:an>
+
+<<< @/snippets/guide/faq/dummy_class_an.php
+
+  </template>
+</codeblock>
 
 **As of version 4.8 the `doctrine/annotations` library is optional and might cause the same message.**
 
diff --git a/docs/snippets/guide/faq/dummy_class_an.php b/docs/snippets/guide/faq/dummy_class_an.php
new file mode 100644
index 000000000..7df8deb56
--- /dev/null
+++ b/docs/snippets/guide/faq/dummy_class_an.php
@@ -0,0 +1,21 @@
+<?php
+
+/**
+ * @OA\Tag(
+ *     name="user",
+ *     description="User related operations"
+ * )
+ * @OA\Info(
+ *     version="1.0",
+ *     title="Example API",
+ *     description="Example info",
+ *     @OA\Contact(name="Swagger API Team")
+ * )
+ * @OA\Server(
+ *     url="https://example.localhost",
+ *     description="API server"
+ * )
+ */
+class OpenApiSpec
+{
+}
diff --git a/docs/snippets/guide/faq/dummy_class_at.php b/docs/snippets/guide/faq/dummy_class_at.php
new file mode 100644
index 000000000..7e1a9ec92
--- /dev/null
+++ b/docs/snippets/guide/faq/dummy_class_at.php
@@ -0,0 +1,18 @@
+<?php
+
+use OpenApi\Attributes as OAT;
+
+#[OAT\Tag(name: "user", description: "User related operations")]
+#[OAT\Info(
+    version: "1.0",
+    title: "Example API",
+    description: "Example info",
+    contact: new OAT\Contact(name: "Swagger API Team"),
+)]
+#[OAT\Server(
+    url: "https://example.localhost",
+    description: "API server",
+)]
+class OpenApiSpec
+{
+}

From 10d49222298f15880e7f57f13fc83aebcf80d1da Mon Sep 17 00:00:00 2001
From: natsuki ueda <biafrajr@gmail.com>
Date: Tue, 11 Feb 2025 14:44:25 +0900
Subject: [PATCH 2/2] OAT to OA

---
 docs/snippets/guide/faq/dummy_class_at.php | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)

diff --git a/docs/snippets/guide/faq/dummy_class_at.php b/docs/snippets/guide/faq/dummy_class_at.php
index 7e1a9ec92..3d1b0e9af 100644
--- a/docs/snippets/guide/faq/dummy_class_at.php
+++ b/docs/snippets/guide/faq/dummy_class_at.php
@@ -1,15 +1,15 @@
 <?php
 
-use OpenApi\Attributes as OAT;
+use OpenApi\Attributes as OA;
 
-#[OAT\Tag(name: "user", description: "User related operations")]
-#[OAT\Info(
+#[OA\Tag(name: "user", description: "User related operations")]
+#[OA\Info(
     version: "1.0",
     title: "Example API",
     description: "Example info",
-    contact: new OAT\Contact(name: "Swagger API Team"),
+    contact: new OA\Contact(name: "Swagger API Team"),
 )]
-#[OAT\Server(
+#[OA\Server(
     url: "https://example.localhost",
     description: "API server",
 )]