@types/swagger-schema-official

Version 2.0.25
Published 2 years ago
11.3 kB
No dependencies
MIT license

Install

npm i @types/swagger-schema-official

yarn add @types/swagger-schema-official

pnpm add @types/swagger-schema-official

Overview

TypeScript definitions for swagger-schema-official

Index

Interfaces

ApiKeySecurity
- in
- name
- type
BaseOAuthSecurity
BaseSecurity
- description
- type
BasicAuthenticationSecurity
- type
Contact
ExternalDocs
- description
- url
Header
- type
Info
License
- name
- url
OAuth2AccessCodeSecurity
OAuth2ApplicationSecurity
OAuth2ImplicitSecurity
OAuth2PasswordSecurity
OAuthScope
Operation
Path
Reference
- $ref
Response
Schema
Spec
Tag
XML

Type Aliases

BaseFormatContrainedParameter
BaseParameter
BaseSchema
BodyParameter
FormDataParameter
GenericFormat
HeaderParameter
IntegerFormat
NumberFormat
Parameter
ParameterCollectionFormat
ParameterType
PathParameter
QueryParameter
SchemaFormatConstraints
Security
StringFormat

Interfaces

interface ApiKeySecurity

interface ApiKeySecurity extends BaseSecurity {}

property in

in: 'query' | 'header';

property name

name: string;

property type

type: 'apiKey';

interface BaseOAuthSecurity

interface BaseOAuthSecurity extends BaseSecurity {}

property flow

flow: 'accessCode' | 'application' | 'implicit' | 'password';

property scopes

scopes?: OAuthScope | undefined;

property type

type: 'oauth2';

interface BaseSecurity

interface BaseSecurity {}

property description

description?: string | undefined;

property type

type: 'basic' | 'apiKey' | 'oauth2';

interface BasicAuthenticationSecurity

interface BasicAuthenticationSecurity extends BaseSecurity {}

property type

type: 'basic';

interface Contact

interface Contact {}

property email

email?: string | undefined;

property name

name?: string | undefined;

property url

url?: string | undefined;

interface ExternalDocs

interface ExternalDocs {}

property description

description?: string | undefined;

property url

url: string;

interface Header extends BaseSchema {}

type: ParameterType;

interface Info

interface Info {}

property contact

contact?: Contact | undefined;

property description

description?: string | undefined;

property license

license?: License | undefined;

property termsOfService

termsOfService?: string | undefined;

property title

title: string;

property version

version: string;

interface License

interface License {}

property name

name: string;

property url

url?: string | undefined;

interface OAuth2AccessCodeSecurity

interface OAuth2AccessCodeSecurity extends BaseOAuthSecurity {}

property authorizationUrl

authorizationUrl: string;

property flow

flow: 'accessCode';

property tokenUrl

tokenUrl: string;

property type

type: 'oauth2';

interface OAuth2ApplicationSecurity

interface OAuth2ApplicationSecurity extends BaseOAuthSecurity {}

property flow

flow: 'application';

property tokenUrl

tokenUrl: string;

property type

type: 'oauth2';

interface OAuth2ImplicitSecurity

interface OAuth2ImplicitSecurity extends BaseOAuthSecurity {}

property authorizationUrl

authorizationUrl: string;

property flow

flow: 'implicit';

property type

type: 'oauth2';

interface OAuth2PasswordSecurity

interface OAuth2PasswordSecurity extends BaseOAuthSecurity {}

property flow

flow: 'password';

property tokenUrl

tokenUrl: string;

property type

type: 'oauth2';

interface OAuthScope

interface OAuthScope {}

index signature

[scopeName: string]: string;

interface Operation

interface Operation {}

property consumes

consumes?: string[] | undefined;

property deprecated

deprecated?: boolean | undefined;

property description

description?: string | undefined;

property externalDocs

externalDocs?: ExternalDocs | undefined;

property operationId

operationId?: string | undefined;

property parameters

parameters?: Array<Parameter | Reference> | undefined;

property produces

produces?: string[] | undefined;

property responses

responses: { [responseName: string]: Response | Reference };

property schemes

schemes?: string[] | undefined;

property security

security?: Array<{ [securityDefinitionName: string]: string[] }> | undefined;

property summary

summary?: string | undefined;

property tags

tags?: string[] | undefined;

interface Path

interface Path {}

property $ref

$ref?: string | undefined;

property delete

delete?: Operation | undefined;

property get

get?: Operation | undefined;

property head

head?: Operation | undefined;

property options

options?: Operation | undefined;

property parameters

parameters?: Array<Parameter | Reference> | undefined;

property patch

patch?: Operation | undefined;

property post

post?: Operation | undefined;

property put

put?: Operation | undefined;

interface Reference

interface Reference {}

property $ref

$ref: string;

interface Response

interface Response {}

property description

description: string;

property examples

examples?: { [exampleName: string]: {} } | undefined;

property headers

headers?: { [headerName: string]: Header } | undefined;

property schema

schema?: Schema | undefined;

interface Schema

interface Schema extends BaseSchema {}

property $ref

$ref?: string | undefined;

property additionalProperties

additionalProperties?: Schema | boolean | undefined;

property allOf

allOf?: Schema[] | undefined;

property discriminator

discriminator?: string | undefined;

property example

example?: any;

property externalDocs

externalDocs?: ExternalDocs | undefined;

property properties

properties?: { [propertyName: string]: Schema } | undefined;

property readOnly

readOnly?: boolean | undefined;

property required

required?: string[] | undefined;

property xml

xml?: XML | undefined;

interface Spec

interface Spec {}

property basePath

basePath?: string | undefined;

property consumes

consumes?: string[] | undefined;

property definitions

definitions?: { [definitionsName: string]: Schema } | undefined;

property externalDocs

externalDocs?: ExternalDocs | undefined;

property host

host?: string | undefined;

property info

info: Info;

property parameters

parameters?:
    | { [parameterName: string]: BodyParameter | QueryParameter }
    | undefined;

property paths

paths: { [pathName: string]: Path };

property produces

produces?: string[] | undefined;

property responses

responses?: { [responseName: string]: Response } | undefined;

property schemes

schemes?: string[] | undefined;

property security

security?: Array<{ [securityDefinitionName: string]: string[] }> | undefined;

property securityDefinitions

securityDefinitions?: { [securityDefinitionName: string]: Security } | undefined;

property swagger

swagger: string;

property tags

tags?: Tag[] | undefined;

interface Tag

interface Tag {}

property description

description?: string | undefined;

property externalDocs

externalDocs?: ExternalDocs | undefined;

property name

name: string;

interface XML

interface XML {}

property attribute

attribute?: boolean | undefined;

property name

name?: string | undefined;

property namespace

namespace?: string | undefined;

property prefix

prefix?: string | undefined;

property wrapped

wrapped?: boolean | undefined;

Type Aliases

type BaseFormatContrainedParameter

type BaseFormatContrainedParameter = BaseParameter & SchemaFormatConstraints;

type BaseParameter

type BaseParameter = {
    name: string;
    in: 'body' | 'query' | 'path' | 'header' | 'formData' | 'body';
    required?: boolean | undefined;
    description?: string | undefined;
};

type BaseSchema

type BaseSchema = {
    type?: ParameterType | undefined;
    format?: string | undefined;
    title?: string | undefined;
    description?: string | undefined;
    default?: any;
    multipleOf?: number | undefined;
    maximum?: number | undefined;
    exclusiveMaximum?: boolean | undefined;
    minimum?: number | undefined;
    exclusiveMinimum?: boolean | undefined;
    maxLength?: number | undefined;
    minLength?: number | undefined;
    pattern?: string | undefined;
    maxItems?: number | undefined;
    minItems?: number | undefined;
    uniqueItems?: boolean | undefined;
    maxProperties?: number | undefined;
    minProperties?: number | undefined;
    enum?: any[] | undefined;
    items?: Schema | Schema[] | undefined;
};

type BodyParameter

type BodyParameter = BaseParameter & {
    in: 'body';
    schema?: Schema | undefined;
};

type FormDataParameter

type FormDataParameter = BaseFormatContrainedParameter &
    BaseSchema & {
        in: 'formData';
        type: ParameterType | 'file';
        allowEmptyValue?: boolean | undefined;
        collectionFormat?: ParameterCollectionFormat | undefined;
    };

type GenericFormat

type GenericFormat = {
    type?: ParameterType | undefined;
    format?: string | undefined;
};

type HeaderParameter

type HeaderParameter = BaseFormatContrainedParameter &
    BaseSchema & {
        in: 'header';
    };

type IntegerFormat

type IntegerFormat = {
    type: 'integer';
    format?: 'int32' | 'int64' | undefined;
};

type NumberFormat

type NumberFormat = {
    type: 'number';
    format?: 'float' | 'double' | undefined;
};

type Parameter

type Parameter =
    | BodyParameter
    | FormDataParameter
    | QueryParameter
    | PathParameter
    | HeaderParameter;

type ParameterCollectionFormat

type ParameterCollectionFormat = 'csv' | 'ssv' | 'tsv' | 'pipes' | 'multi';

type ParameterType

type ParameterType =
    | 'string'
    | 'number'
    | 'integer'
    | 'boolean'
    | 'array'
    | 'object'
    | 'file';

type PathParameter

type PathParameter = BaseFormatContrainedParameter &
    BaseSchema & {
        in: 'path';
        required: true;
    };

type QueryParameter

type QueryParameter = BaseFormatContrainedParameter &
    BaseSchema & {
        in: 'query';
        allowEmptyValue?: boolean | undefined;
        collectionFormat?: ParameterCollectionFormat | undefined;
    };

type SchemaFormatConstraints

type SchemaFormatConstraints =
    | GenericFormat
    | IntegerFormat
    | NumberFormat
    | StringFormat;

type Security

type Security =
    | BasicAuthenticationSecurity
    | OAuth2AccessCodeSecurity
    | OAuth2ApplicationSecurity
    | OAuth2ImplicitSecurity
    | OAuth2PasswordSecurity
    | ApiKeySecurity;

type StringFormat

type StringFormat = {
    type: 'string';
    format?: '' | 'byte' | 'binary' | 'date' | 'date-time' | 'password' | undefined;
};

Package Files (1)

index.d.ts

Dependencies (0)

No dependencies.

Dev Dependencies (0)

No dev dependencies.

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this oneto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/swagger-schema-official.

Markdown

[![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/swagger-schema-official)

HTML

<a href="https://www.jsdocs.io/package/@types/swagger-schema-official"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>

Updated 2 years ago.
Package analyzed in 3977 ms.
Missing or incorrect documentation? Open an issue for this package.