@stoplight/types
Advanced tools
Comparing version 13.17.0 to 13.18.0
@@ -1,9 +0,12 @@ | ||
import { Extensions, IExternalDocs } from "./http-spec"; | ||
import { IExternalDocs } from './http-spec'; | ||
export interface IShareableNode { | ||
id: string; | ||
} | ||
export interface ISpecExtensions { | ||
extensions?: Extensions; | ||
} | ||
export interface IComponentNode { | ||
key: string; | ||
} | ||
export interface INode extends IShareableNode { | ||
export interface INode extends ISpecExtensions, IShareableNode { | ||
/** An internal identifier. For example, the operationId property in OAS. */ | ||
@@ -14,5 +17,4 @@ iid?: string; | ||
description?: string; | ||
extensions?: Extensions; | ||
} | ||
export interface INodeTag extends IShareableNode { | ||
export interface INodeTag extends IShareableNode, ISpecExtensions { | ||
name: string; | ||
@@ -23,3 +25,3 @@ description?: string; | ||
} | ||
export interface INodeVariable { | ||
export interface INodeVariable extends ISpecExtensions { | ||
default: string; | ||
@@ -29,3 +31,3 @@ description?: string; | ||
} | ||
interface INodeExampleBase { | ||
interface INodeExampleBase extends ISpecExtensions { | ||
key: string; | ||
@@ -41,2 +43,5 @@ summary?: string; | ||
} | ||
export interface Extensions { | ||
[key: string]: unknown; | ||
} | ||
export {}; |
import { JSONSchema7 } from 'json-schema'; | ||
import { Dictionary } from './basic'; | ||
import { IComponentNode, INode, INodeExample, INodeExternalExample, IShareableNode } from './graph'; | ||
import { IComponentNode, INode, INodeExample, INodeExternalExample, IShareableNode, ISpecExtensions } from './graph'; | ||
import { IServer } from './servers'; | ||
@@ -8,3 +8,3 @@ /** | ||
*/ | ||
export interface IHttpService extends INode, IShareableNode { | ||
export interface IHttpService extends INode, IShareableNode, ISpecExtensions { | ||
name: string; | ||
@@ -53,3 +53,3 @@ version: string; | ||
*/ | ||
export interface IHttpOperation<Bundle extends boolean = false> extends INode, IShareableNode { | ||
export interface IHttpOperation<Bundle extends boolean = false> extends INode, IShareableNode, ISpecExtensions { | ||
method: string; | ||
@@ -89,3 +89,3 @@ path: string; | ||
} | ||
export interface IHttpOperationRequestBody<Bundle extends boolean = false> extends IShareableNode { | ||
export interface IHttpOperationRequestBody<Bundle extends boolean = false> extends IShareableNode, ISpecExtensions { | ||
contents?: IMediaTypeContent<Bundle>[]; | ||
@@ -96,3 +96,3 @@ required?: boolean; | ||
} | ||
export interface IHttpOperationResponse<Bundle extends boolean = false> extends IShareableNode { | ||
export interface IHttpOperationResponse<Bundle extends boolean = false> extends IShareableNode, ISpecExtensions { | ||
code: string; | ||
@@ -106,3 +106,3 @@ contents?: IMediaTypeContent<Bundle>[]; | ||
*/ | ||
export interface IHttpParam<Bundle extends boolean = false> extends IHttpContent<Bundle>, IShareableNode { | ||
export interface IHttpParam<Bundle extends boolean = false> extends IHttpContent<Bundle>, IShareableNode, ISpecExtensions { | ||
name: string; | ||
@@ -185,3 +185,3 @@ style: HttpParamStyles; | ||
*/ | ||
export interface IHttpContent<Bundle extends boolean = false> extends IShareableNode { | ||
export interface IHttpContent<Bundle extends boolean = false> extends IShareableNode, ISpecExtensions { | ||
schema?: JSONSchema7; | ||
@@ -194,3 +194,3 @@ examples?: (Bundle extends true ? INodeExample | INodeExternalExample | (IHttpKeyedReference) : INodeExample | INodeExternalExample)[]; | ||
} | ||
export interface IHttpEncoding<Bundle extends boolean = false> { | ||
export interface IHttpEncoding<Bundle extends boolean = false> extends ISpecExtensions { | ||
property: string; | ||
@@ -207,6 +207,5 @@ style: HttpParamStyles.Form | HttpParamStyles.CommaDelimited | HttpParamStyles.SpaceDelimited | HttpParamStyles.PipeDelimited | HttpParamStyles.DeepObject; | ||
export declare type HttpSecurityScheme = IApiKeySecurityScheme | IBearerSecurityScheme | IBasicSecurityScheme | IOauth2SecurityScheme | IOpenIdConnectSecurityScheme | IMutualTLSSecurityScheme; | ||
interface ISecurityScheme extends IShareableNode { | ||
interface ISecurityScheme extends IShareableNode, ISpecExtensions { | ||
key: string; | ||
description?: string; | ||
extensions: Extensions; | ||
} | ||
@@ -266,6 +265,3 @@ export interface IApiKeySecurityScheme extends ISecurityScheme { | ||
}; | ||
export interface Extensions { | ||
[key: string]: unknown; | ||
} | ||
export interface IExternalDocs { | ||
export interface IExternalDocs extends ISpecExtensions { | ||
description?: string; | ||
@@ -272,0 +268,0 @@ url: string; |
{ | ||
"name": "@stoplight/types", | ||
"version": "13.17.0", | ||
"version": "13.18.0", | ||
"description": "Common typings for the Stoplight ecosystem.", | ||
@@ -5,0 +5,0 @@ "keywords": [], |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
45559
928