@typespec/openapi 0.54.0-dev.2 → 0.54.0-dev.3
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.
- package/README.md +16 -16
- package/dist/src/decorators.d.ts +1 -1
- package/dist/src/decorators.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -54,14 +54,14 @@ Attach some custom data to the OpenAPI element generated from this type.
|
|
|
54
54
|
|
|
55
55
|
##### Target
|
|
56
56
|
|
|
57
|
-
`
|
|
57
|
+
`unknown`
|
|
58
58
|
|
|
59
59
|
##### Parameters
|
|
60
60
|
|
|
61
|
-
| Name | Type
|
|
62
|
-
| ----- |
|
|
63
|
-
| key | `valueof
|
|
64
|
-
| value | `
|
|
61
|
+
| Name | Type | Description |
|
|
62
|
+
| ----- | ---------------- | ----------------------------------- |
|
|
63
|
+
| key | `valueof string` | Extension key. Must start with `x-` |
|
|
64
|
+
| value | `unknown` | Extension value. |
|
|
65
65
|
|
|
66
66
|
##### Examples
|
|
67
67
|
|
|
@@ -86,14 +86,14 @@ Specify the OpenAPI `externalDocs` property for this type.
|
|
|
86
86
|
|
|
87
87
|
##### Target
|
|
88
88
|
|
|
89
|
-
`
|
|
89
|
+
`unknown`
|
|
90
90
|
|
|
91
91
|
##### Parameters
|
|
92
92
|
|
|
93
|
-
| Name | Type
|
|
94
|
-
| ----------- |
|
|
95
|
-
| url | `valueof
|
|
96
|
-
| description | `valueof
|
|
93
|
+
| Name | Type | Description |
|
|
94
|
+
| ----------- | ---------------- | ----------------------- |
|
|
95
|
+
| url | `valueof string` | Url to the docs |
|
|
96
|
+
| description | `valueof string` | Description of the docs |
|
|
97
97
|
|
|
98
98
|
##### Examples
|
|
99
99
|
|
|
@@ -120,9 +120,9 @@ The service `title` and `version` are already specified using `@service`.
|
|
|
120
120
|
|
|
121
121
|
##### Parameters
|
|
122
122
|
|
|
123
|
-
| Name | Type
|
|
124
|
-
| -------------- |
|
|
125
|
-
| additionalInfo | `
|
|
123
|
+
| Name | Type | Description |
|
|
124
|
+
| -------------- | ----------------------------------- | ---------------------- |
|
|
125
|
+
| additionalInfo | [`AdditionalInfo`](#additionalinfo) | Additional information |
|
|
126
126
|
|
|
127
127
|
#### `@operationId`
|
|
128
128
|
|
|
@@ -138,9 +138,9 @@ Specify the OpenAPI `operationId` property for this operation.
|
|
|
138
138
|
|
|
139
139
|
##### Parameters
|
|
140
140
|
|
|
141
|
-
| Name | Type
|
|
142
|
-
| ----------- |
|
|
143
|
-
| operationId | `valueof
|
|
141
|
+
| Name | Type | Description |
|
|
142
|
+
| ----------- | ---------------- | ------------------- |
|
|
143
|
+
| operationId | `valueof string` | Operation id value. |
|
|
144
144
|
|
|
145
145
|
##### Examples
|
|
146
146
|
|
package/dist/src/decorators.d.ts
CHANGED
|
@@ -30,7 +30,7 @@ export interface ExternalDocs {
|
|
|
30
30
|
/**
|
|
31
31
|
* Allows referencing an external resource for extended documentation.
|
|
32
32
|
* @param url The URL for the target documentation. Value MUST be in the format of a URL.
|
|
33
|
-
* @param
|
|
33
|
+
* @param description A short description of the target documentation.
|
|
34
34
|
*/
|
|
35
35
|
export declare function $externalDocs(context: DecoratorContext, target: Type, url: string, description?: string): void;
|
|
36
36
|
export declare function getExternalDocs(program: Program, entity: Type): ExternalDocs | undefined;
|
package/dist/src/decorators.js
CHANGED
|
@@ -71,7 +71,7 @@ const externalDocsKey = createStateSymbol("externalDocs");
|
|
|
71
71
|
/**
|
|
72
72
|
* Allows referencing an external resource for extended documentation.
|
|
73
73
|
* @param url The URL for the target documentation. Value MUST be in the format of a URL.
|
|
74
|
-
* @param
|
|
74
|
+
* @param description A short description of the target documentation.
|
|
75
75
|
*/
|
|
76
76
|
export function $externalDocs(context, target, url, description) {
|
|
77
77
|
const doc = { url };
|