Update Documentation with core changes (#167)

blake-discourse · discoursebuild · web-flow · commit 59bb85e8bd0a · 2025-10-17T10:20:34.000-06:00
Co-authored-by: discoursebuild &lt;build@discourse.org&gt;
diff --git a/openapi.json b/openapi.json
@@ -7273,9 +7273,13 @@
                   "type": "object",
                   "properties": {
                     "locked": {
-                      "type": "boolean"
+                      "type": "boolean",
+                      "description": "Whether the post is locked"
                     }
-                  }
+                  },
+                  "required": [
+                    "locked"
+                  ]
                 }
               }
             }
@@ -7288,7 +7292,8 @@
                 "type": "object",
                 "properties": {
                   "locked": {
-                    "type": "string"
+                    "type": "string",
+                    "description": "Whether to lock the post (true/false)"
                   }
                 },
                 "required": [
diff --git a/openapi.yml b/openapi.yml
@@ -5211,6 +5211,9 @@ paths:
                 properties:
                   locked:
                     type: boolean
+                    description: Whether the post is locked
+                required:
+                - locked
       requestBody:
         content:
           application/json:
@@ -5219,6 +5222,7 @@ paths:
               properties:
                 locked:
                   type: string
+                  description: Whether to lock the post (true/false)
               required:
               - locked
   "/post_actions.json":

Original file line number	Diff line number	Diff line change
`@@ -7273,9 +7273,13 @@`
`7273`	`7273`	`"type": "object",`
`7274`	`7274`	`"properties": {`
`7275`	`7275`	`"locked": {`
`7276`		`- "type": "boolean"`
	`7276`	`+ "type": "boolean",`
	`7277`	`+ "description": "Whether the post is locked"`
`7277`	`7278`	`}`
`7278`		`- }`
	`7279`	`+ },`
	`7280`	`+ "required": [`
	`7281`	`+ "locked"`
	`7282`	`+ ]`
`7279`	`7283`	`}`
`7280`	`7284`	`}`
`7281`	`7285`	`}`
`@@ -7288,7 +7292,8 @@`
`7288`	`7292`	`"type": "object",`
`7289`	`7293`	`"properties": {`
`7290`	`7294`	`"locked": {`
`7291`		`- "type": "string"`
	`7295`	`+ "type": "string",`
	`7296`	`+ "description": "Whether to lock the post (true/false)"`
`7292`	`7297`	`}`
`7293`	`7298`	`},`
`7294`	`7299`	`"required": [`