diff --git a/public/openapi/bindapi.json b/public/openapi/bindapi.json index da68609..74ebbc4 100644 --- a/public/openapi/bindapi.json +++ b/public/openapi/bindapi.json @@ -2,10 +2,10 @@ "openapi": "3.0.2", "info": { "title": "bindAPI", - "version": "0.0.1", + "version": "0.0.2", "description": "TODO …", "contact": { - "name": "micha Espey", + "name": "Micha Espey", "email": "tracer@24unix.net" } }, @@ -31,6 +31,9 @@ { "name": "Server" }, + { + "name": "DNS" + }, { "name": "Domains" } @@ -66,6 +69,45 @@ ] } }, + "/dyndns/{hostname}": { + "get": { + "tags": [ + "DNS" + ], + "summary": "Updated a DynDNS host.", + "description": "Updates a predefined custom DNS entry.", + "operationId": "updateDynDNS", + "parameters": [ + { + "name": "hostname", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "$ref": "#/components/requestBodies/dyndns-put" + }, + "responses": { + "200": { + "description": "OK" + }, + "401": { + "description": "API key is missing or invalid." + }, + "404": { + "description": "Domain not found." + } + }, + "security": [ + { + "Authorization": [] + } + ] + } + }, "/domains": { "get": { "tags": [ @@ -250,6 +292,20 @@ } }, "requestBodies": { + "dyndns-put": { + "required": true, + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/dyndns" + }, + "example": { + "a": "1.2.3.4", + "aaaa": "1bad::babe" + } + } + } + }, "domain-post": { "required": true, "content": { @@ -394,6 +450,20 @@ } } }, + "dyndns": { + "type": "object", + "properties": { + "a": { + "type": "string", + "example": "1.2.3.4" + }, + "aaaa": { + "type": "string", + "example": "1bad::babe" + } + } + + }, "domain": { "description": "Representation of a domain.\n", "type": "object",