docs

package
v0.0.0-...-62f0cde Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 22, 2022 License: Apache-2.0 Imports: 1 Imported by: 0

Documentation

Overview

Package docs defines swagger docs for API specification

Ingress Server

establishes comms with database to pass data to a downstream server for inference

Schemes: http, https
Host: localhost:8080
BasePath: /
Version: 0.0.2-stable
License: Apache 2.0 https://github.com/aarnphm/dha-ps/blob/master/LICENSE
Contact: Aaron Pham<aaronpham0103@gmail.com>

Consumes:
- application/json
- application/xml

Produces:
- application/json
- application/xml

Security:
- api_key:

SecurityDefinitions:
api_key:
     type: apiKey
     name: Authorization
     in: header

swagger:meta

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type GenericError

type GenericError struct {
	// in:body
	Body struct {
		Code    int32 `json:"code"`
		Message error `json:"message"`
	} `json:"body"`
}

GenericError is the default error message that is generated

swagger:response genericError

type TooManyRequestError

type TooManyRequestError struct {
}

TooManyRequestError handles HTTP 429

swagger:response tooManyRequestError

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL