Update Documentation with core changes (#107)

Co-authored-by: discoursebuild <[email protected]>
discourse · Apr 3, 2024 · b027b27 · b027b27
1 parent b301da6
commit b027b27
Show file tree

Hide file tree

Showing 2 changed files with 127 additions and 0 deletions.
diff --git a/openapi.json b/openapi.json
@@ -7638,6 +7638,72 @@
         }
       }
     },
+    "/site/basic-info.json": {
+      "get": {
+        "summary": "Get site basic info",
+        "tags": [
+          "Site"
+        ],
+        "operationId": "getSiteBasicInfo",
+        "description": "Can be used to fetch basic info about a site",
+        "responses": {
+          "200": {
+            "description": "success response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "additionalProperties": false,
+                  "properties": {
+                    "logo_url": {
+                      "type": "string"
+                    },
+                    "logo_small_url": {
+                      "type": "string"
+                    },
+                    "apple_touch_icon_url": {
+                      "type": "string"
+                    },
+                    "favicon_url": {
+                      "type": "string"
+                    },
+                    "title": {
+                      "type": "string"
+                    },
+                    "description": {
+                      "type": "string"
+                    },
+                    "header_primary_color": {
+                      "type": "string"
+                    },
+                    "header_background_color": {
+                      "type": "string"
+                    },
+                    "login_required": {
+                      "type": "boolean"
+                    },
+                    "mobile_logo_url": {
+                      "type": "string"
+                    }
+                  },
+                  "required": [
+                    "logo_url",
+                    "logo_small_url",
+                    "apple_touch_icon_url",
+                    "favicon_url",
+                    "title",
+                    "description",
+                    "header_primary_color",
+                    "header_background_color",
+                    "login_required",
+                    "mobile_logo_url"
+                  ]
+                }
+              }
+            }
+          }
+        }
+      }
+    },
     "/tag_groups.json": {
       "get": {
         "summary": "Get a list of tag groups",
@@ -11926,6 +11992,9 @@
                         "display_sidebar_tags": {
                           "type": "boolean"
                         },
+                        "can_pick_theme_with_custom_homepage": {
+                          "type": "boolean"
+                        },
                         "user_auth_tokens": {
                           "type": "array",
                           "items": {
@@ -12940,6 +13009,9 @@
                         "display_sidebar_tags": {
                           "type": "boolean"
                         },
+                        "can_pick_theme_with_custom_homepage": {
+                          "type": "boolean"
+                        },
                         "user_auth_tokens": {
                           "type": "array",
                           "items": {
@@ -13889,6 +13961,9 @@
                         "display_sidebar_tags": {
                           "type": "boolean"
                         },
+                        "can_pick_theme_with_custom_homepage": {
+                          "type": "boolean"
+                        },
                         "user_auth_tokens": {
                           "type": "array",
                           "items": {

diff --git a/openapi.yml b/openapi.yml
@@ -5438,6 +5438,52 @@ paths:
                 - archetypes
                 - user_fields
                 - auth_providers
+  "/site/basic-info.json":
+    get:
+      summary: Get site basic info
+      tags:
+      - Site
+      operationId: getSiteBasicInfo
+      description: Can be used to fetch basic info about a site
+      responses:
+        '200':
+          description: success response
+          content:
+            application/json:
+              schema:
+                additionalProperties: false
+                properties:
+                  logo_url:
+                    type: string
+                  logo_small_url:
+                    type: string
+                  apple_touch_icon_url:
+                    type: string
+                  favicon_url:
+                    type: string
+                  title:
+                    type: string
+                  description:
+                    type: string
+                  header_primary_color:
+                    type: string
+                  header_background_color:
+                    type: string
+                  login_required:
+                    type: boolean
+                  mobile_logo_url:
+                    type: string
+                required:
+                - logo_url
+                - logo_small_url
+                - apple_touch_icon_url
+                - favicon_url
+                - title
+                - description
+                - header_primary_color
+                - header_background_color
+                - login_required
+                - mobile_logo_url
   "/tag_groups.json":
     get:
       summary: Get a list of tag groups
@@ -8461,6 +8507,8 @@ paths:
                         type: array
                       display_sidebar_tags:
                         type: boolean
+                      can_pick_theme_with_custom_homepage:
+                        type: boolean
                       user_auth_tokens:
                         type: array
                         items:
@@ -9189,6 +9237,8 @@ paths:
                         type: array
                       display_sidebar_tags:
                         type: boolean
+                      can_pick_theme_with_custom_homepage:
+                        type: boolean
                       user_auth_tokens:
                         type: array
                         items:
@@ -9878,6 +9928,8 @@ paths:
                         type: array
                       display_sidebar_tags:
                         type: boolean
+                      can_pick_theme_with_custom_homepage:
+                        type: boolean
                       user_auth_tokens:
                         type: array
                         items: