117 lines
2.7 KiB
YAML
117 lines
2.7 KiB
YAML
definitions:
|
|
dns.Msg:
|
|
properties:
|
|
answer:
|
|
description: Holds the RR(s) of the answer section.
|
|
items: {}
|
|
type: array
|
|
authenticatedData:
|
|
type: boolean
|
|
authoritative:
|
|
type: boolean
|
|
checkingDisabled:
|
|
type: boolean
|
|
extra:
|
|
description: Holds the RR(s) of the additional section.
|
|
items: {}
|
|
type: array
|
|
id:
|
|
type: integer
|
|
ns:
|
|
description: Holds the RR(s) of the authority section.
|
|
items: {}
|
|
type: array
|
|
opcode:
|
|
type: integer
|
|
question:
|
|
description: Holds the RR(s) of the question section.
|
|
items:
|
|
$ref: '#/definitions/dns.Question'
|
|
type: array
|
|
rcode:
|
|
type: integer
|
|
recursionAvailable:
|
|
type: boolean
|
|
recursionDesired:
|
|
type: boolean
|
|
response:
|
|
type: boolean
|
|
truncated:
|
|
type: boolean
|
|
zero:
|
|
type: boolean
|
|
type: object
|
|
dns.Question:
|
|
properties:
|
|
name:
|
|
description: '"cdomain-name" specifies encoding (and may be compressed)'
|
|
type: string
|
|
qclass:
|
|
type: integer
|
|
qtype:
|
|
type: integer
|
|
type: object
|
|
util.Request:
|
|
properties:
|
|
class:
|
|
description: Request class, eg. IN
|
|
example: 1
|
|
type: integer
|
|
name:
|
|
description: Domain to query
|
|
example: example.com
|
|
type: string
|
|
port:
|
|
description: Port to make DNS request on
|
|
example: 53
|
|
type: integer
|
|
retries:
|
|
description: Number of failures to make before giving up
|
|
example: 2
|
|
type: integer
|
|
server:
|
|
description: Server to query
|
|
example: 1.0.0.1
|
|
type: string
|
|
timeout:
|
|
description: Duration to wait until marking request as failed
|
|
example: 2000000000
|
|
type: integer
|
|
type:
|
|
description: Request type, eg. A, AAAA, NAPTR
|
|
example: 1
|
|
type: integer
|
|
type: object
|
|
util.Response:
|
|
properties:
|
|
response:
|
|
$ref: '#/definitions/dns.Msg'
|
|
description: The full DNS response
|
|
rtt:
|
|
description: The time it took to make the DNS query
|
|
example: 2000000000
|
|
type: integer
|
|
type: object
|
|
info:
|
|
contact: {}
|
|
paths:
|
|
/api/v1/placeholder:
|
|
post:
|
|
operationId: make-query
|
|
parameters:
|
|
- description: query params
|
|
in: body
|
|
name: request
|
|
required: true
|
|
schema:
|
|
$ref: '#/definitions/util.Request'
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: OK
|
|
schema:
|
|
$ref: '#/definitions/util.Response'
|
|
summary: Create (and execute) a DNS query
|
|
swagger: "2.0"
|