Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "api/openapi/index"

Index

Object literals

Object literals

Const spec

spec: object

openapi

openapi: string = "3.0.0"

paths

paths: object

Type declaration

  • /collections/{collectionName}/aggregate: object
    • get: object
      • description: string
      • operationId: string
      • parameters: (object | object)[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • text/event-stream: object
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/aggregate/to-array: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
                • properties: object
                  • data: object
                    • type: string
                    • items: object
                      • type: string
                  • status: object
                    • enum: string[]
                    • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/count-documents: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
                • properties: object
                  • data: object
                    • type: string
                  • status: object
                    • enum: string[]
                    • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/delete-many: object
    • delete: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • type: string
              • properties: object
                • filter: object
                  • type: string
                • options: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/delete-one: object
    • delete: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • type: string
              • properties: object
                • filter: object
                  • type: string
                • options: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/distinct: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
                • properties: object
                  • data: object
                    • type: string
                    • items: object
                      • $ref: string
                  • status: object
                    • enum: string[]
                    • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/find: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • text/event-stream: object
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/find-one: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
                • properties: object
                  • data: object
                    • nullable: boolean
                    • type: string
                  • status: object
                    • enum: string[]
                    • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/find/to-array: object
    • get: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
                • properties: object
                  • data: object
                    • type: string
                    • items: object
                      • type: string
                  • status: object
                    • enum: string[]
                    • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/insert-many: object
    • post: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • required: string[]
              • type: string
              • properties: object
                • data: object
                  • type: string
                  • items: object
                    • type: string
                • options: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/insert-one: object
    • post: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • required: string[]
              • type: string
              • properties: object
                • data: object
                  • type: string
                • options: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/update-many: object
    • put: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • required: string[]
              • type: string
              • properties: object
                • filter: object
                  • type: string
                • options: object
                  • type: string
                • update: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string
  • /collections/{collectionName}/update-one: object
    • put: object
      • description: string
      • operationId: string
      • parameters: object[]
      • x-router-controller: string
      • requestBody: object
        • required: boolean
        • x-name: string
        • content: object
          • application/json: object
            • schema: object
              • required: string[]
              • type: string
              • properties: object
                • filter: object
                  • type: string
                • options: object
                  • type: string
                • update: object
                  • type: string
      • responses: object
        • 2XX: object
          • description: string
          • content: object
            • application/json: object
              • schema: object
                • type: string
        • 4XX: object
          • $ref: string
        • default: object
          • $ref: string

servers

servers: any[]

components

components: object

responses

responses: object

Type declaration

  • genericClientError: object
    • description: string
    • content: object
      • application/json: object
        • schema: object
          • $ref: string
  • genericServerError: object
    • description: string
    • content: object
      • application/json: object
        • schema: object
          • $ref: string

schemas

schemas: any

info

info: object

title

title: string = "mongorestorm-server"

version

version: any = require('../../../package.json').version

Generated using TypeDoc