openapi-specification-types 0.0.1

package/common.d.ts

@@ -0,0 +1,2 @@
+export type StringObject = { [key: string]: string }
+export type AtWillObject = { [key: string]: any }

package/components.d.ts

@@ -0,0 +1,52 @@
+import { AtWillObject, StringObject } from './common'
+import { Definitions } from './definitions'
+import { Schema } from './schema'
+
+export interface Components {
+  schemas: Definitions
+  requestBodies: RequestBodies
+}
+
+export interface RequestBodies {
+  [name: string]: RequestBody
+}
+
+export interface RequestBody {
+  description: string
+  content: {
+    [type: string]: {
+      schema: Schema
+      example: AtWillObject
+      examples: Record<string, AtWillObject>
+      encoding: Record<string, AtWillObject>
+    }
+  }
+  required: boolean
+}
+
+export interface SecuritySchemes {
+  [name: string]: SecurityScheme
+}
+
+export interface SecurityScheme {
+  type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect'
+  description: string
+  name: string
+  in: 'query' | 'header' | 'cookie'
+  scheme: string
+  bearerFormat: string
+  flows: {
+    implicit: OAuthFlow
+    password: OAuthFlow
+    clientCredentials: OAuthFlow
+    authorizationCode: OAuthFlow
+  }
+  openIdConnectUrl: string
+}
+
+interface OAuthFlow {
+  authorizationUrl: string
+  tokenUrl: string
+  refreshUrl: string
+  scopes: StringObject
+}

package/definitions.d.ts

@@ -0,0 +1,28 @@
+import { Properties, Schema } from './schema'
+
+export interface Definition {
+  type: Schema['type']
+  properties: Properties
+  required: string[]
+}
+
+export interface Definitions {
+  [name: string]: Definition
+}
+
+export interface SecurityDefinitions {
+  api_key: {
+    type: string
+    name: string
+    in: string
+  }
+  petstore_auth: {
+    type: string
+    authorizationUrl: string
+    flow: string
+    scopes: {
+      'read:pets': string
+      'write:pets': string
+    }
+  }
+}

package/index-v2.d.ts

@@ -0,0 +1,30 @@
+import { AtWillObject } from './common'
+import { Tag } from './tag'
+import { Paths } from './paths'
+import { Definitions, SecurityDefinitions } from './definitions'
+
+export interface OpenAPISpecificationV2 extends AtWillObject {
+  swagger: string
+  host: string
+  basePath: string
+  schemes: string[]
+  consumes: string[]
+  info: {
+    description: string
+    version: string
+    title: string
+    termsOfService: string
+    contact: Record<'name' | 'url' | 'email', string>
+    license: Record<'name' | 'url', string>
+  }
+
+  paths: Paths
+  definitions: Definitions
+
+  securityDefinitions: SecurityDefinitions
+  tags: Tag[]
+  externalDocs: {
+    description: string
+    url: string
+  }
+}

package/index-v3.d.ts

@@ -0,0 +1,25 @@
+import { AtWillObject } from './common'
+import { Server } from './server'
+import { Tag } from './tag'
+import { Paths } from './paths'
+import { Components } from './components'
+
+export interface OpenAPISpecificationV3 extends AtWillObject {
+  openapi: string
+  info: {
+    description: string
+    version: string
+    title: string
+    termsOfService: string
+    contact: Record<'name' | 'url' | 'email', string>
+    license: Record<'name' | 'url', string>
+  }
+  externalDocs: {
+    description: string
+    url: string
+  }
+  servers: Server[]
+  tags: Tag[]
+  paths: Paths
+  components: Components
+}

package/index.d.ts

@@ -0,0 +1,10 @@
+export * from './index-v2'
+export * from './index-v2'
+
+export * from './components'
+export * from './definitions'
+export * from './parameter'
+export * from './paths'
+export * from './schema'
+export * from './server'
+export * from './tag'

package/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "openapi-specification-types",
+  "version": "0.0.1",
+  "types": "./index.d.ts",
+  "main": "index.js",
+  "keywords": [
+    "openapi",
+    "types"
+  ],
+  "author": "",
+  "license": "ISC"
+}

package/parameter.d.ts

@@ -0,0 +1,10 @@
+import { Schema } from './schema'
+
+export interface Parameter extends Schema {
+  name: string
+  in: 'body' | 'header' | 'query' | 'path' | 'formData'
+  type?: Schema['type']
+  description?: string
+  required?: boolean
+  schema?: Schema
+}

package/paths.d.ts

@@ -0,0 +1,40 @@
+import { Parameter } from './parameter'
+import { Schema, Properties } from './schema'
+
+export interface Paths {
+  [path: string]: {
+    get: Method
+    put: Method
+    post: Method
+    delete: Method
+    options: Method
+    head: Method
+    patch: Method
+    parameters: Parameter[]
+  }
+}
+
+export interface Method {
+  tags: string[]
+  summary: string
+  description: string
+  operationId: string
+  consumes: string[]
+  produces: string[]
+  parameters: Parameter[]
+  responses: Responses
+  security: Security[]
+}
+
+export interface Responses {
+  [status: number]: {
+    description: string
+    headers: Properties
+    schema: Schema
+  }
+}
+
+export interface Security {
+  petstore_auth: string[]
+  api_key: string[]
+}

package/schema.d.ts

@@ -0,0 +1,26 @@
+type SchemaNumberType = 'integer' | 'long' | 'float' | 'byte' | 'TypesLong' | 'TypesString' | 'string'
+type SchemaStringType = 'byte' | 'binary' | 'date' | 'dateTime' | 'password'
+type SchemaBooleanType = 'boolean'
+type SchemaObjectType = 'object'
+type SchemaArrayType = 'array'
+
+type SchemaType = SchemaNumberType | SchemaStringType | SchemaBooleanType | SchemaObjectType | SchemaArrayType
+
+export interface Schema {
+  type?: SchemaType | SchemaType[]
+  items?: Schema
+  additionalProperties?: Schema
+  originalRef?: string
+  $ref?: string
+  required?: boolean
+  format?: string
+  description?: string
+  schema?: Schema
+  properties?: Properties
+  xml?: { wrapped?: boolean }
+  enum?: string[]
+}
+
+export interface Properties {
+  [name: string]: Schema
+}

package/server.d.ts

@@ -0,0 +1,11 @@
+export interface Server {
+  url: string
+  description: string
+  variables: Record<string, Variable>
+}
+
+export interface Variable {
+  enum: string[]
+  default: string
+  description: string
+}

package/tag.d.ts

@@ -0,0 +1,5 @@
+export interface Tag {
+  name: string
+  description: string
+  externalDocs?: { description: string; url: string }
+}