@tsed/openspec 6.73.6 → 6.74.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1,6 +1,8 @@
|
|
|
1
1
|
import { OS3Schema } from "./OS3Schema";
|
|
2
2
|
import { OpenSpecHash } from "../common/OpenSpecHash";
|
|
3
3
|
import { OS3MediaType } from "./OS3MediaType";
|
|
4
|
+
import { OS3Example } from "./OS3Example";
|
|
5
|
+
import { OpenSpecRef } from "../common/OpenSpecRef";
|
|
4
6
|
export interface OS3RequestBody<Schema = OS3Schema> {
|
|
5
7
|
/**
|
|
6
8
|
* A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.
|
|
@@ -14,4 +16,5 @@ export interface OS3RequestBody<Schema = OS3Schema> {
|
|
|
14
16
|
* Determines if the request body is required in the request. Defaults to false.
|
|
15
17
|
*/
|
|
16
18
|
required?: boolean;
|
|
19
|
+
examples?: OpenSpecHash<OS3Example | OpenSpecRef>;
|
|
17
20
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS3RequestBody.js","sourceRoot":"","sources":["../../src/openspec3/OS3RequestBody.ts"],"names":[],"mappings":"","sourcesContent":["import {OS3Schema} from \"./OS3Schema\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS3MediaType} from \"./OS3MediaType\";\n\nexport interface OS3RequestBody<Schema = OS3Schema> {\n /**\n * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n */\n description?: string;\n /**\n * A map containing descriptions of potential request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*\n */\n content?: OpenSpecHash<OS3MediaType<Schema>>;\n /**\n * Determines if the request body is required in the request. Defaults to false.\n */\n required?: boolean;\n}\n"]}
|
|
1
|
+
{"version":3,"file":"OS3RequestBody.js","sourceRoot":"","sources":["../../src/openspec3/OS3RequestBody.ts"],"names":[],"mappings":"","sourcesContent":["import {OS3Schema} from \"./OS3Schema\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS3MediaType} from \"./OS3MediaType\";\nimport {OS3Example} from \"./OS3Example\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\n\nexport interface OS3RequestBody<Schema = OS3Schema> {\n /**\n * A brief description of the request body. This could contain examples of use. CommonMark syntax MAY be used for rich text representation.\n */\n description?: string;\n /**\n * A map containing descriptions of potential request body. The key is a media type or [media type range](https://tools.ietf.org/html/rfc7231#appendix-D) and the value describes it. For responses that match multiple keys, only the most specific key is applicable. e.g. text/plain overrides text/*\n */\n content?: OpenSpecHash<OS3MediaType<Schema>>;\n /**\n * Determines if the request body is required in the request. Defaults to false.\n */\n required?: boolean;\n\n examples?: OpenSpecHash<OS3Example | OpenSpecRef>;\n}\n"]}
|