feat: common schema

public/openapi/read.yaml

@@ -37,6 +37,73 @@ tags:
     description: Disparate method of categorizing topics
   - name: shorthand
     description: Convenience and utility routes for accessing other part of the API
+components:
+  schemas:
+    CommonProps:
+      type: object
+      properties:
+        loggedIn:
+          type: boolean
+        relative_path:
+          type: string
+        url:
+          type: string
+        bodyClass:
+          type: string
+        _header:
+          type: object
+          properties:
+            tags:
+              type: object
+              properties:
+                meta:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      name:
+                        type: string
+                      content:
+                        type: string
+                      noEscape:
+                        type: boolean
+                      property:
+                        type: string
+                    required:
+                      - name
+                      - content
+                      - noEscape
+                      - property
+                link:
+                  type: array
+                  items:
+                    type: object
+                    properties:
+                      rel:
+                        type: string
+                      type:
+                        type: string
+                      href:
+                        type: string
+                      title:
+                        type: string
+                      sizes:
+                        type: string
+                    required:
+                      - rel
+                      - href
+                      - type
+                      - sizes
+        widgets:
+          type: object
+          properties:
+            footer:
+              type: array
+              items:
+                type: object
+                properties:
+                  html:
+                    type: string
 paths:
   /api/:
     get:
@@ -51,7 +118,9 @@ paths:
           content:
             application/json:
               schema:
-                type: object
+                allOf:
+                  - $ref: '#/components/schemas/CommonProps'
+                  - type: object
                     properties:
                       title:
                         type: string
@@ -345,10 +414,6 @@ paths:
                                       type: string
                             imageClass:
                               type: string
-                  loggedIn:
-                    type: boolean
-                  relative_path:
-                    type: string
                       template:
                         type: object
                         properties:
@@ -356,10 +421,6 @@ paths:
                             type: string
                           categories:
                             type: boolean
-                  url:
-                    type: string
-                  bodyClass:
-                    type: string
                       topics:
                         type: array
                         items:
@@ -552,71 +613,6 @@ paths:
                               type: string
                             teaserPid:
                               type: number
-                  _header:
-                    type: object
-                    properties:
-                      tags:
-                        type: object
-                        properties:
-                          meta:
-                            type: array
-                            items:
-                              type: object
-                              properties:
-                                name:
-                                  type: string
-                                content:
-                                  type: string
-                                noEscape:
-                                  type: boolean
-                                property:
-                                  type: string
-                          link:
-                            type: array
-                            items:
-                              type: object
-                              properties:
-                                rel:
-                                  type: string
-                                type:
-                                  type: string
-                                href:
-                                  type: string
-                                title:
-                                  type: string
-                                sizes:
-                                  type: string
-                  widgets:
-                    type: object
-                    properties:
-                      sidebar:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            html:
-                              type: string
-                      header:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            html:
-                              type: string
-                      footer:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            html:
-                              type: string
-                      motd:
-                        type: array
-                        items:
-                          type: object
-                          properties:
-                            html:
-                              type: string
         "304":
           description: ""
   "/api/post/{pid}/raw":