Skip to content

Commit 393dbe6

Browse files
edmondasedmondas
committed
docs(api): regenerate the openapi spec for the rrset POST and PATCH operations
1 parent 0fa9bfe commit 393dbe6

1 file changed

Lines changed: 276 additions & 0 deletions

File tree

‎docs/api/openapi.json‎

Lines changed: 276 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5150,6 +5150,282 @@
51505150
"apiKeyHeader": []
51515151
}
51525152
]
5153+
},
5154+
"post": {
5155+
"tags": [
5156+
"rrsets"
5157+
],
5158+
"summary": "Replace or create an RRSet",
5159+
"description": "Alias of PUT on this path.",
5160+
"operationId": "v2CreateZoneRRSet",
5161+
"parameters": [
5162+
{
5163+
"name": "id",
5164+
"in": "path",
5165+
"description": "Zone ID",
5166+
"required": true,
5167+
"schema": {
5168+
"type": "integer"
5169+
}
5170+
}
5171+
],
5172+
"requestBody": {
5173+
"description": "RRSet data",
5174+
"required": true,
5175+
"content": {
5176+
"application/json": {
5177+
"schema": {
5178+
"properties": {
5179+
"name": {
5180+
"description": "Record name (use @ for zone apex)",
5181+
"type": "string",
5182+
"example": "www"
5183+
},
5184+
"type": {
5185+
"description": "Record type",
5186+
"type": "string",
5187+
"example": "A"
5188+
},
5189+
"ttl": {
5190+
"description": "Time to live in seconds",
5191+
"type": "integer",
5192+
"example": 3600
5193+
},
5194+
"records": {
5195+
"description": "Array of record data",
5196+
"type": "array",
5197+
"items": {
5198+
"properties": {
5199+
"content": {
5200+
"description": "Record content/value",
5201+
"type": "string",
5202+
"example": "192.168.1.1"
5203+
},
5204+
"priority": {
5205+
"description": "Priority (for MX, SRV records, etc.). Default: 0",
5206+
"type": "integer",
5207+
"example": 10
5208+
},
5209+
"disabled": {
5210+
"description": "Disabled flag (default: false)",
5211+
"type": "boolean",
5212+
"example": false
5213+
}
5214+
},
5215+
"type": "object"
5216+
}
5217+
}
5218+
},
5219+
"type": "object"
5220+
}
5221+
}
5222+
}
5223+
},
5224+
"responses": {
5225+
"200": {
5226+
"description": "RRSet replaced successfully",
5227+
"content": {
5228+
"application/json": {
5229+
"schema": {
5230+
"properties": {
5231+
"success": {
5232+
"type": "boolean",
5233+
"example": true
5234+
},
5235+
"message": {
5236+
"type": "string",
5237+
"example": "RRSet replaced successfully"
5238+
},
5239+
"data": {
5240+
"properties": {
5241+
"name": {
5242+
"type": "string",
5243+
"example": "www"
5244+
},
5245+
"type": {
5246+
"type": "string",
5247+
"example": "A"
5248+
},
5249+
"ttl": {
5250+
"type": "integer",
5251+
"example": 3600
5252+
},
5253+
"records": {
5254+
"type": "array",
5255+
"items": {
5256+
"properties": {
5257+
"content": {
5258+
"type": "string",
5259+
"example": "192.168.1.1"
5260+
},
5261+
"priority": {
5262+
"type": "integer",
5263+
"example": 0
5264+
},
5265+
"disabled": {
5266+
"type": "boolean",
5267+
"example": false
5268+
}
5269+
},
5270+
"type": "object"
5271+
}
5272+
}
5273+
},
5274+
"type": "object"
5275+
}
5276+
},
5277+
"type": "object"
5278+
}
5279+
}
5280+
}
5281+
}
5282+
},
5283+
"security": [
5284+
{
5285+
"bearerAuth": []
5286+
},
5287+
{
5288+
"apiKeyHeader": []
5289+
}
5290+
]
5291+
},
5292+
"patch": {
5293+
"tags": [
5294+
"rrsets"
5295+
],
5296+
"summary": "Replace or create an RRSet",
5297+
"description": "Alias of PUT on this path.",
5298+
"operationId": "v2PatchZoneRRSet",
5299+
"parameters": [
5300+
{
5301+
"name": "id",
5302+
"in": "path",
5303+
"description": "Zone ID",
5304+
"required": true,
5305+
"schema": {
5306+
"type": "integer"
5307+
}
5308+
}
5309+
],
5310+
"requestBody": {
5311+
"description": "RRSet data",
5312+
"required": true,
5313+
"content": {
5314+
"application/json": {
5315+
"schema": {
5316+
"properties": {
5317+
"name": {
5318+
"description": "Record name (use @ for zone apex)",
5319+
"type": "string",
5320+
"example": "www"
5321+
},
5322+
"type": {
5323+
"description": "Record type",
5324+
"type": "string",
5325+
"example": "A"
5326+
},
5327+
"ttl": {
5328+
"description": "Time to live in seconds",
5329+
"type": "integer",
5330+
"example": 3600
5331+
},
5332+
"records": {
5333+
"description": "Array of record data",
5334+
"type": "array",
5335+
"items": {
5336+
"properties": {
5337+
"content": {
5338+
"description": "Record content/value",
5339+
"type": "string",
5340+
"example": "192.168.1.1"
5341+
},
5342+
"priority": {
5343+
"description": "Priority (for MX, SRV records, etc.). Default: 0",
5344+
"type": "integer",
5345+
"example": 10
5346+
},
5347+
"disabled": {
5348+
"description": "Disabled flag (default: false)",
5349+
"type": "boolean",
5350+
"example": false
5351+
}
5352+
},
5353+
"type": "object"
5354+
}
5355+
}
5356+
},
5357+
"type": "object"
5358+
}
5359+
}
5360+
}
5361+
},
5362+
"responses": {
5363+
"200": {
5364+
"description": "RRSet replaced successfully",
5365+
"content": {
5366+
"application/json": {
5367+
"schema": {
5368+
"properties": {
5369+
"success": {
5370+
"type": "boolean",
5371+
"example": true
5372+
},
5373+
"message": {
5374+
"type": "string",
5375+
"example": "RRSet replaced successfully"
5376+
},
5377+
"data": {
5378+
"properties": {
5379+
"name": {
5380+
"type": "string",
5381+
"example": "www"
5382+
},
5383+
"type": {
5384+
"type": "string",
5385+
"example": "A"
5386+
},
5387+
"ttl": {
5388+
"type": "integer",
5389+
"example": 3600
5390+
},
5391+
"records": {
5392+
"type": "array",
5393+
"items": {
5394+
"properties": {
5395+
"content": {
5396+
"type": "string",
5397+
"example": "192.168.1.1"
5398+
},
5399+
"priority": {
5400+
"type": "integer",
5401+
"example": 0
5402+
},
5403+
"disabled": {
5404+
"type": "boolean",
5405+
"example": false
5406+
}
5407+
},
5408+
"type": "object"
5409+
}
5410+
}
5411+
},
5412+
"type": "object"
5413+
}
5414+
},
5415+
"type": "object"
5416+
}
5417+
}
5418+
}
5419+
}
5420+
},
5421+
"security": [
5422+
{
5423+
"bearerAuth": []
5424+
},
5425+
{
5426+
"apiKeyHeader": []
5427+
}
5428+
]
51535429
}
51545430
},
51555431
"/v2/zones/{id}/rrsets/{name}/{type}": {

0 commit comments

Comments
 (0)