docs: update API documentation

kikuomax · kikuomax · commit 97162ea3e114 · 2025-06-29T00:09:13.000+09:00
diff --git a/api-docs/cdk-rest-api-with-spec.api.md b/api-docs/cdk-rest-api-with-spec.api.md
@@ -34,7 +34,7 @@ export interface IRestApiWithSpec extends aws_apigateway.IRestApi {
 
 // @beta
 export interface JsonSchemaEx extends aws_apigateway.JsonSchema {
-    additionalItems?: JsonSchemaEx[];
+    additionalItems?: boolean | JsonSchemaEx;
     additionalProperties?: boolean | JsonSchemaEx;
     allOf?: JsonSchemaEx[];
     anyOf?: JsonSchemaEx[];
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.augmentauthorizer.md b/api-docs/markdown/cdk-rest-api-with-spec.augmentauthorizer.md
@@ -66,6 +66,7 @@ Security scheme object to add to `authorizer`<!-- -->.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [IAuthorizerWithSpec](./cdk-rest-api-with-spec.iauthorizerwithspec.md)
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.iauthorizerwithspec.md
@@ -59,3 +59,4 @@ SecuritySchemeObject
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addmethod.md b/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addmethod.md
@@ -80,6 +80,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 apigateway.Method
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addresource.md b/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.addresource.md
@@ -64,6 +64,7 @@ _(Optional)_
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [IResourceWithSpec](./cdk-rest-api-with-spec.iresourcewithspec.md)
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.iresourcewithspec.md
@@ -119,3 +119,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.irestapiwithspec.addmodel.md b/api-docs/markdown/cdk-rest-api-with-spec.irestapiwithspec.addmodel.md
@@ -62,6 +62,7 @@ props
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 apigateway.Model
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.irestapiwithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.irestapiwithspec.md
@@ -87,3 +87,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.jsonschemaex.additionalitems.md b/api-docs/markdown/cdk-rest-api-with-spec.jsonschemaex.additionalitems.md
@@ -12,5 +12,5 @@ Extension of [additionalItems](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-c
 **Signature:**
 
 ```typescript
-additionalItems?: JsonSchemaEx[];
+additionalItems?: boolean | JsonSchemaEx;
 ```
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.jsonschemaex.md b/api-docs/markdown/cdk-rest-api-with-spec.jsonschemaex.md
@@ -58,7 +58,7 @@ Description
 
 </td><td>
 
-[JsonSchemaEx](./cdk-rest-api-with-spec.jsonschemaex.md)<!-- -->\[\]
+boolean \| [JsonSchemaEx](./cdk-rest-api-with-spec.jsonschemaex.md)
 
 
 </td><td>
@@ -334,3 +334,4 @@ apigateway.IModel
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.md b/api-docs/markdown/cdk-rest-api-with-spec.md
@@ -182,3 +182,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.methodoptionswithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.methodoptionswithspec.md
@@ -139,3 +139,4 @@ string
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.methodresponsewithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.methodresponsewithspec.md
@@ -59,3 +59,4 @@ string
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.modeloptionswithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.modeloptionswithspec.md
@@ -63,3 +63,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.parameterkey._constructor_.md b/api-docs/markdown/cdk-rest-api-with-spec.parameterkey._constructor_.md
@@ -94,3 +94,4 @@ boolean
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.parameterkey.md b/api-docs/markdown/cdk-rest-api-with-spec.parameterkey.md
@@ -193,3 +193,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.parameterkey.parseparameterkey.md b/api-docs/markdown/cdk-rest-api-with-spec.parameterkey.parseparameterkey.md
@@ -50,6 +50,7 @@ Parameter key to be parsed.
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 [ParameterKey](./cdk-rest-api-with-spec.parameterkey.md)
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.resourceoptionswithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.resourceoptionswithspec.md
@@ -59,3 +59,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec._constructor_.md b/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec._constructor_.md
@@ -76,3 +76,4 @@ props
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.addmodel.md b/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.addmodel.md
@@ -62,6 +62,7 @@ props
 
 </td></tr>
 </tbody></table>
+
 **Returns:**
 
 apigateway.Model
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.md b/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspec.md
@@ -156,3 +156,4 @@ Description
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspecprops.md b/api-docs/markdown/cdk-rest-api-with-spec.restapiwithspecprops.md
@@ -78,3 +78,4 @@ string
 
 </td></tr>
 </tbody></table>
+
diff --git a/api-docs/markdown/index.md b/api-docs/markdown/index.md
@@ -29,3 +29,4 @@ Describe the Amazon API Gateway and OpenAPI definition at once with CDK.
 
 </td></tr>
 </tbody></table>
+

Original file line number	Diff line number	Diff line change
`@@ -59,3 +59,4 @@ SecuritySchemeObject`
`59`	`59`
`60`	`60`	`</td></tr>`
`61`	`61`	`</tbody></table>`
	`62`	`+`
Original file line number	Diff line number	Diff line change
`@@ -119,3 +119,4 @@ Description`
`119`	`119`
`120`	`120`	`</td></tr>`
`121`	`121`	`</tbody></table>`
	`122`	`+`
Original file line number	Diff line number	Diff line change
`@@ -87,3 +87,4 @@ Description`
`87`	`87`
`88`	`88`	`</td></tr>`
`89`	`89`	`</tbody></table>`
	`90`	`+`