Merge pull request #46164 from nextcloud/bugfix/noid/fix-openapi

[stable28] fix(openapi): Regenerate OpenAPI after server changes
nextcloud · Jun 27, 2024 · aea9eaf · aea9eaf
2 parents 7c60d70 + 2dbec08
commit aea9eaf
Show file tree

Hide file tree

Showing 2 changed files with 104 additions and 1 deletion.
diff --git a/.github/workflows/openapi.yml b/.github/workflows/openapi.yml
@@ -21,8 +21,9 @@ jobs:
         uses: shivammathur/setup-php@v2
         with:
           php-version: '8.2'
-          extensions: xml
+          extensions: ctype, curl, dom, fileinfo, gd, json, libxml, mbstring, openssl, pcntl, pdo, posix, session, simplexml, xml, xmlreader, xmlwriter, zip, zlib
           coverage: none
+          ini-file: development
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 

diff --git a/core/openapi.json b/core/openapi.json
@@ -656,6 +656,19 @@
                     }
                 ],
                 "parameters": [
+                    {
+                        "name": "guestFallback",
+                        "in": "query",
+                        "description": "Fallback to guest avatar if not found",
+                        "schema": {
+                            "type": "integer",
+                            "default": 0,
+                            "enum": [
+                                0,
+                                1
+                            ]
+                        }
+                    },
                     {
                         "name": "userId",
                         "in": "path",
@@ -696,13 +709,35 @@
                             }
                         }
                     },
+                    "201": {
+                        "description": "Avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
+                        "content": {
+                            "*/*": {
+                                "schema": {
+                                    "type": "string",
+                                    "format": "binary"
+                                }
+                            }
+                        }
+                    },
                     "404": {
                         "description": "Avatar not found",
                         "content": {
                             "application/json": {
                                 "schema": {}
                             }
                         }
+                    },
+                    "500": {
+                        "description": ""
                     }
                 }
             }
@@ -724,6 +759,19 @@
                     }
                 ],
                 "parameters": [
+                    {
+                        "name": "guestFallback",
+                        "in": "query",
+                        "description": "Fallback to guest avatar if not found",
+                        "schema": {
+                            "type": "integer",
+                            "default": 0,
+                            "enum": [
+                                0,
+                                1
+                            ]
+                        }
+                    },
                     {
                         "name": "userId",
                         "in": "path",
@@ -764,13 +812,35 @@
                             }
                         }
                     },
+                    "201": {
+                        "description": "Avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
+                        "content": {
+                            "*/*": {
+                                "schema": {
+                                    "type": "string",
+                                    "format": "binary"
+                                }
+                            }
+                        }
+                    },
                     "404": {
                         "description": "Avatar not found",
                         "content": {
                             "application/json": {
                                 "schema": {}
                             }
                         }
+                    },
+                    "500": {
+                        "description": ""
                     }
                 }
             }
@@ -814,6 +884,14 @@
                 "responses": {
                     "200": {
                         "description": "Custom avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
                         "content": {
                             "*/*": {
                                 "schema": {
@@ -825,6 +903,14 @@
                     },
                     "201": {
                         "description": "Avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
                         "content": {
                             "*/*": {
                                 "schema": {
@@ -893,6 +979,14 @@
                 "responses": {
                     "200": {
                         "description": "Custom avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
                         "content": {
                             "*/*": {
                                 "schema": {
@@ -904,6 +998,14 @@
                     },
                     "201": {
                         "description": "Avatar returned",
+                        "headers": {
+                            "X-NC-IsCustomAvatar": {
+                                "schema": {
+                                    "type": "integer",
+                                    "format": "int64"
+                                }
+                            }
+                        },
                         "content": {
                             "*/*": {
                                 "schema": {