generated from ts-stack/starter
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Added contact-object, license-object and xml-object to exports
- Loading branch information
1 parent
9a9a61f
commit f279802
Showing
8 changed files
with
498 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
import { SpecExtFieldPattern, SpecificationExtension } from '../origin/specification-extension'; | ||
|
||
/** | ||
* Contact information for the exposed API. | ||
* | ||
* This object MAY be extended with [Specification Extensions][1]. | ||
* | ||
* [1]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#specificationExtensions | ||
* | ||
* ### Example with JSON | ||
* | ||
```json | ||
{ | ||
"name": "API Support", | ||
"url": "https://www.example.com/support", | ||
"email": "[email protected]" | ||
} | ||
``` | ||
* | ||
* ### Example with YAML | ||
* | ||
```yaml | ||
name: API Support | ||
url: https://www.example.com/support | ||
email: [email protected] | ||
``` | ||
*/ | ||
export type XContactObject<T extends SpecExtFieldPattern = any> = SpecificationExtension<T> & { | ||
/** | ||
* The identifying name of the contact person/organization. | ||
*/ | ||
name?: string; | ||
/** | ||
* The URL pointing to the contact information. This MUST be in the form of a URL. | ||
*/ | ||
url?: string; | ||
/** | ||
* The email address of the contact person/organization. | ||
* This MUST be in the form of an email address. | ||
*/ | ||
email?: string; | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
import { SpecExtFieldPattern, SpecificationExtension } from '../origin/specification-extension'; | ||
|
||
/** | ||
* License information for the exposed API. | ||
* | ||
* This object MAY be extended with [Specification Extensions][1]. | ||
* | ||
* [1]: https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#specificationExtensions | ||
* | ||
* ### Example with JSON | ||
* | ||
```json | ||
{ | ||
"name": "Apache 2.0", | ||
"identifier": "Apache-2.0" | ||
} | ||
``` | ||
* | ||
* ### Example with YAML | ||
* | ||
```yaml | ||
name: Apache 2.0 | ||
identifier: Apache-2.0 | ||
``` | ||
*/ | ||
export type XLicenseObject<T extends SpecExtFieldPattern = any> = SpecificationExtension<T> & { | ||
/** | ||
* The license name used for the API. | ||
*/ | ||
name: string; | ||
/** | ||
* An [SPDX][1] license expression for the API. The `identifier` field is mutually exclusive | ||
* of the `url` field. | ||
* | ||
* [1]: https://spdx.org/spdx-specification-21-web-version#h.jxpfx0ykyb60 | ||
*/ | ||
identifier?: string; | ||
/** | ||
* A URL to the license used for the API. This MUST be in the form of a URL. | ||
* The `url` field is mutually exclusive of the `identifier` field. | ||
*/ | ||
url?: string; | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.