openapi-types - npm Package Compare versions

Comparing version 1.0.3 to 1.0.4

dist/index.d.ts

@@ -7,3 +7,315 @@ export declare namespace OpenAPI {
         openapi: string;
+        info: InfoObject;
+        servers?: ServerObject[];
+        paths: {
+            [path: string]: PathItemObject;
+        };
+        components?: ComponentsObject;
+        security?: SecurityRequirementObject[];
+        tags?: TagObject[];
+        externalDocs?: ExternalDocumentationObject;
     }
+    interface InfoObject {
+        title: string;
+        description?: string;
+        termsOfService?: string;
+        contact?: ContactObject;
+        license?: LicenseObject;
+        version: string;
+    }
+    interface ContactObject {
+        name?: string;
+        url?: string;
+        email?: string;
+    }
+    interface LicenseObject {
+        name: string;
+        url?: string;
+    }
+    interface ServerObject {
+        url: string;
+        description?: string;
+        variables?: {
+            [variable: string]: ServerVariableObject;
+        };
+    }
+    interface ServerVariableObject {
+        enum?: string[];
+        'default': string;
+        description?: string;
+    }
+    interface PathObject {
+        [pattern: string]: PathItemObject;
+    }
+    interface PathItemObject {
+        $ref?: string;
+        summary?: string;
+        description?: string;
+        get?: OperationObject;
+        put?: OperationObject;
+        post?: OperationObject;
+        delete?: OperationObject;
+        options?: OperationObject;
+        head?: OperationObject;
+        patch?: OperationObject;
+        trace?: OperationObject;
+        servers?: ServerObject[];
+        parameters?: (ReferenceObject | ParameterObject)[];
+    }
+    interface OperationObject {
+        tags?: string[];
+        summary?: string;
+        description?: string;
+        externalDocs?: ExternalDocumentationObject;
+        operationId?: string;
+        parameters?: (ReferenceObject | ParameterObject)[];
+        requestBody?: (ReferenceObject | RequestBodyObject);
+        responses?: ResponsesObject;
+        callbacks?: {
+            [callback: string]: ReferenceObject | CallbackObject;
+        };
+        deprecated?: boolean;
+        security?: SecurityRequirementObject[];
+        servers?: ServerObject[];
+    }
+    interface ExternalDocumentationObject {
+        description?: string;
+        url: string;
+    }
+    interface ParameterObject extends ParameterBaseObject {
+        name: string;
+        in: string;
+    }
+    interface HeaderObject extends ParameterBaseObject {
+    }
+    interface ParameterBaseObject {
+        description?: string;
+        required?: boolean;
+        deprecated?: boolean;
+        allowEmptyValue?: boolean;
+        style?: string;
+        explode?: boolean;
+        allowReserved?: boolean;
+        schema?: ReferenceObject | SchemaObject;
+        example?: any;
+        examples?: {
+            [media: string]: ReferenceObject | ExampleObject;
+        };
+        content?: {
+            [media: string]: MediaTypeObject;
+        };
+    }
+    type SchemaObject = ArraySchemaObject | NonArraySchemaObject;
+    interface ArraySchemaObject extends BaseSchemaObject {
+        type: 'array';
+        items: ReferenceObject | SchemaObject;
+    }
+    interface NonArraySchemaObject extends BaseSchemaObject {
+        type: 'null' | 'boolean' | 'object' | 'number' | 'string' | 'integer';
+    }
+    interface BaseSchemaObject {
+        title?: string;
+        description?: string;
+        format?: string;
+        'default'?: any;
+        multipleOf?: number;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        additionalProperties?: boolean | ReferenceObject | SchemaObject;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+        maxProperties?: number;
+        minProperties?: number;
+        required?: string[];
+        'enum'?: any[];
+        properties?: {
+            [name: string]: SchemaObject;
+        };
+        allOf?: (ReferenceObject | SchemaObject)[];
+        oneOf?: (ReferenceObject | SchemaObject)[];
+        anyOf?: (ReferenceObject | SchemaObject)[];
+        not?: (ReferenceObject | SchemaObject);
+        nullable?: boolean;
+        discriminator?: DiscriminatorObject;
+        readOnly?: boolean;
+        writeOnly?: boolean;
+        xml?: XMLObject;
+        externalDocs?: ExternalDocumentationObject;
+        example?: any;
+        deprecated?: boolean;
+    }
+    interface DiscriminatorObject {
+        propertyName: string;
+        mapping?: {
+            [value: string]: string;
+        };
+    }
+    interface XMLObject {
+        name?: string;
+        namespace?: string;
+        prefix?: string;
+        attribute?: boolean;
+        wrapped?: boolean;
+    }
+    interface ReferenceObject {
+        $ref: string;
+    }
+    interface ExampleObject {
+        summary?: string;
+        description?: string;
+        value?: any;
+        externalValue?: string;
+    }
+    interface MediaTypeObject {
+        schema?: ReferenceObject | SchemaObject;
+        example?: any;
+        examples?: {
+            [media: string]: ReferenceObject | ExampleObject;
+        };
+        encoding?: {
+            [media: string]: EncodingObject;
+        };
+    }
+    interface EncodingObject {
+        contentType?: string;
+        headers?: {
+            [header: string]: ReferenceObject | HeaderObject;
+        };
+        style?: string;
+        explode?: boolean;
+        allowReserved?: boolean;
+    }
+    interface RequestBodyObject {
+        description?: string;
+        content: {
+            [media: string]: MediaTypeObject;
+        };
+        required?: boolean;
+    }
+    interface ResponsesObject {
+        [code: string]: (ReferenceObject | ResponseObject);
+    }
+    interface ResponseObject {
+        description: string;
+        headers?: {
+            [header: string]: ReferenceObject | HeaderObject;
+        };
+        content?: {
+            [media: string]: MediaTypeObject;
+        };
+        links?: {
+            [link: string]: ReferenceObject | LinkObject;
+        };
+    }
+    interface LinkObject {
+        operationRef?: string;
+        operationId?: string;
+        parameters?: {
+            [parameter: string]: any;
+        };
+        requestBody?: any;
+        description?: string;
+        server?: ServerObject;
+    }
+    interface CallbackObject {
+        [url: string]: PathItemObject;
+    }
+    interface SecurityRequirementObject {
+        apiKey?: string[];
+        http?: string[];
+        oauth2?: string[];
+        openIdConnect?: string[];
+    }
+    interface ComponentsObject {
+        schemas?: {
+            [key: string]: ReferenceObject | SchemaObject;
+        };
+        responses?: {
+            [key: string]: ReferenceObject | ResponseObject;
+        };
+        parameters?: {
+            [key: string]: ReferenceObject | ParameterObject;
+        };
+        examples?: {
+            [key: string]: ReferenceObject | ExampleObject;
+        };
+        requestBodies?: {
+            [key: string]: ReferenceObject | RequestBodyObject;
+        };
+        headers?: {
+            [key: string]: ReferenceObject | HeaderObject;
+        };
+        securitySchemes?: {
+            [key: string]: ReferenceObject | SecuritySchemeObject;
+        };
+        links?: {
+            [key: string]: ReferenceObject | LinkObject;
+        };
+        callbacks?: {
+            [key: string]: ReferenceObject | CallbackObject;
+        };
+    }
+    type SecuritySchemeObject = HttpSecurityScheme | ApiKeySecurityScheme | OAuth2SecurityScheme | OpenIdSecurityScheme;
+    interface HttpSecurityScheme {
+        type: 'http';
+        description?: string;
+        scheme: string;
+        bearerFormat?: string;
+    }
+    interface ApiKeySecurityScheme {
+        type: 'apiKey';
+        description?: string;
+        name: string;
+        in: string;
+    }
+    interface OAuth2SecurityScheme {
+        type: 'oauth2';
+        flows: {
+            implicit?: {
+                authorizationUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            password?: {
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            clientCredentials?: {
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+            authorizationCode?: {
+                authorizationUrl: string;
+                tokenUrl: string;
+                refreshUrl?: string;
+                scopes: {
+                    [scope: string]: string;
+                };
+            };
+        };
+    }
+    interface OpenIdSecurityScheme {
+        type: 'openIdConnect';
+        description?: string;
+        openIdConnectUrl: string;
+    }
+    interface TagObject {
+        name: string;
+        description?: string;
+        externalDocs?: ExternalDocumentationObject;
+    }
 }
@@ -10,0 +322,0 @@ export declare namespace OpenAPIV2 {

package.json

 {
   "name": "openapi-types",
-  "version": "1.0.3",
+  "version": "1.0.4",
   "description": "Types for OpenAPI documents.",
@@ -5,0 +5,0 @@ "main": "./dist/index.js",

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

20001

increased by82.99%

Lines of code

589

increased by112.64%

No dependency changes