Switch annotation/attribute tab order to make showing attributes the …

…default (#1587)
zircote · May 2, 2024 · d7a9c21 · d7a9c21
1 parent 520ffb7
commit d7a9c21
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 44 deletions.
diff --git a/docs/.vitepress/theme/components/Codeblock.vue b/docs/.vitepress/theme/components/Codeblock.vue
@@ -1,12 +1,12 @@
 <template>
   <div>
     <tabs :options="{ useUrlFragment: false }">
-      <tab :id="anId" name="Annotations">
-        <slot name="an"></slot>
-      </tab>
       <tab :id="atId" name="Attributes">
         <slot name="at"></slot>
       </tab>
+      <tab :id="anId" name="Annotations">
+        <slot name="an"></slot>
+      </tab>
     </tabs>
   </div>
 </template>

diff --git a/docs/guide/cookbook.md b/docs/guide/cookbook.md
@@ -278,17 +278,17 @@ Form posts are `@OA\Post` requests with a `multipart/form-data` `@OA\RequestBody
 Unless specified each endpoint needs to declare what security schemes it supports. However, there is a way
 to also configure security schemes globally for the whole API.
 
-This is done on the `@OA\OpenApi` annotations:
+This is done on the `@OA\OpenApi` annotation:
 
 <codeblock id="minimal">
-  <template v-slot:an>
+  <template v-slot:at>
 
-<<< @/snippets/guide/cookbook/default_security_an.php
+<<< @/snippets/guide/cookbook/default_security_at.php
 
   </template>
-  <template v-slot:at>
+  <template v-slot:an>
 
-<<< @/snippets/guide/cookbook/default_security_at.php
+<<< @/snippets/guide/cookbook/default_security_an.php
 
   </template>
 </codeblock>

diff --git a/docs/guide/required-elements.md b/docs/guide/required-elements.md
@@ -9,17 +9,17 @@ The endpoint, in turn, needs to have a path and at least one response.
 
 ## Minimum required annotations
 
-With the above in mind a minimal API with a single endpoint could look like this
+With the above in mind a minimal API with a single endpoint could look like this:
 
 <codeblock id="minimal">
-  <template v-slot:an>
+  <template v-slot:at>
 
-<<< @/snippets/minimal_api_an.php
+<<< @/snippets/minimal_api_at.php
 
   </template>
-  <template v-slot:at>
+  <template v-slot:an>
 
-<<< @/snippets/minimal_api_at.php
+<<< @/snippets/minimal_api_an.php
 
   </template>
 </codeblock>

diff --git a/docs/index.md b/docs/index.md
@@ -20,17 +20,17 @@ features:
 
 ### 2. Update your code
 
-Add `swagger-php` annotations or attributes to your source code.
+Add `swagger-php` attributes or annotations to your source code.
 
 <codeblock id="minimal">
-  <template v-slot:an>
+  <template v-slot:at>
 
-<<< @/snippets/minimal_api_an.php
+<<< @/snippets/minimal_api_at.php
 
   </template>
-  <template v-slot:at>
+  <template v-slot:an>
 
-<<< @/snippets/minimal_api_at.php
+<<< @/snippets/minimal_api_an.php
 
   </template>
 </codeblock>

diff --git a/docs/snippets/example_annotations.php b/docs/snippets/example_annotations.php
diff --git a/docs/snippets/guide/cookbook/default_security_an.php b/docs/snippets/guide/cookbook/default_security_an.php
@@ -13,6 +13,6 @@
  *   scheme="bearer"
  * )
  */
-class OpenApi
+class OpenApiSpec
 {
 }
diff --git a/docs/snippets/minimal_api_at.php b/docs/snippets/minimal_api_at.php
@@ -17,7 +17,3 @@ public function getResource()
         // ...
     }
 }
-
-class OpenApiSpec
-{
-}
-Original file line number
+Diff line change
@@ Expand Up / @@ -17,7 +17,3 @@ public function getResource() @@
             // ...
         }
     }
-    class OpenApiSpec
-    {
-    }