-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1050 from isomerpages/release/v0.56.0
release(v0.56.0): merge to prod
- Loading branch information
Showing
26 changed files
with
1,980 additions
and
1,114 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,230 @@ | ||
| openapi: 3.0.0 | ||
| info: | ||
| version: "1.0.0" | ||
| title: "GIG DNS Management API" | ||
| description: "An API to manage DNS records for GovTech Domains" | ||
|
|
||
| paths: | ||
| /dns-records: | ||
| post: | ||
| summary: Add a DNS record | ||
| description: Add a DNS record of various types to the DNS management system along with a contact email. | ||
| security: | ||
| - ApiKeyAuth: [] | ||
| parameters: | ||
| - in: header | ||
| name: X-API-KEY | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: API key required to authorize requests. | ||
| example: "1234567890abcdef" | ||
| requestBody: | ||
| required: true | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| required: | ||
| - record | ||
| properties: | ||
| email: | ||
| type: string | ||
| format: email | ||
| description: The contact email address for this DNS record. | ||
| record: | ||
| $ref: "#/components/schemas/DNSRecord" | ||
| example: | ||
| email: "[email protected]" | ||
| record: | ||
| type: "A" | ||
| name: "example.com" | ||
| content: "192.168.1.1" | ||
| responses: | ||
| "201": | ||
| description: DNS record successfully added. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| message: | ||
| type: string | ||
| example: "DNS record added successfully." | ||
| "401": | ||
| description: Unauthorized. | ||
| "400": | ||
| description: Invalid request data. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| message: | ||
| type: string | ||
| example: "Invalid data provided." | ||
| "500": | ||
| description: Server error. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| message: | ||
| type: string | ||
| example: "Internal server error." | ||
| get: | ||
| summary: Retrieve DNS records | ||
| description: Get a list of DNS records for a specified name. | ||
| parameters: | ||
| - in: query | ||
| name: name | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: The name of the DNS record to retrieve. | ||
| responses: | ||
| "200": | ||
| description: A list of DNS records. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: array | ||
| items: | ||
| $ref: "#/components/schemas/DNSRecord" | ||
| "401": | ||
| description: Unauthorized. | ||
| "404": | ||
| description: No records found for the specified name. | ||
| delete: | ||
| summary: Delete a DNS record by name and type | ||
| description: Delete a specific DNS record identified by its name and type. | ||
| parameters: | ||
| - in: query | ||
| name: name | ||
| required: true | ||
| schema: | ||
| type: string | ||
| description: The name of the DNS record to be deleted. | ||
| - in: query | ||
| name: type | ||
| required: true | ||
| schema: | ||
| type: string | ||
| enum: | ||
| [ | ||
| "A", | ||
| "AAAA", | ||
| "CNAME", | ||
| "TXT", | ||
| "SRV", | ||
| "LOC", | ||
| "MX", | ||
| "NS", | ||
| "SPF", | ||
| "CAA", | ||
| "DNSKEY", | ||
| "DS", | ||
| ] | ||
| description: The type of the DNS record to be deleted. | ||
| responses: | ||
| "200": | ||
| description: DNS record successfully deleted. | ||
| content: | ||
| application/json: | ||
| schema: | ||
| type: object | ||
| properties: | ||
| message: | ||
| type: string | ||
| example: "DNS record successfully deleted" | ||
| "401": | ||
| description: Unauthorized. | ||
| "404": | ||
| description: DNS record not found. | ||
| components: | ||
| securitySchemes: | ||
| ApiKeyAuth: | ||
| type: apiKey | ||
| in: header | ||
| name: X-API-KEY | ||
| description: API key required to authorize requests. | ||
| schemas: | ||
| DNSRecord: | ||
| type: object | ||
| required: | ||
| - type | ||
| - name | ||
| - content | ||
| properties: | ||
| type: | ||
| type: string | ||
| description: The type of the DNS record. | ||
| enum: | ||
| [ | ||
| "A", | ||
| "AAAA", | ||
| "CNAME", | ||
| "TXT", | ||
| "SRV", | ||
| "LOC", | ||
| "MX", | ||
| "NS", | ||
| "SPF", | ||
| "CAA", | ||
| "DNSKEY", | ||
| "DS", | ||
| ] | ||
| name: | ||
| type: string | ||
| description: The name of the DNS record. | ||
| content: | ||
| oneOf: | ||
| - type: string | ||
| - $ref: "#/components/schemas/DNSKEYData" | ||
| - $ref: "#/components/schemas/DSData" | ||
| description: The content of the DNS record. Varies depending on the record type. | ||
| priority: | ||
| type: integer | ||
| description: Priority of the record (used for MX and SRV records). | ||
| DNSKEYData: | ||
| type: object | ||
| required: | ||
| - flags | ||
| - protocol | ||
| - algorithm | ||
| - publicKey | ||
| properties: | ||
| flags: | ||
| type: integer | ||
| description: An unsigned 16-bit integer representing DNSKEY flags. | ||
| protocol: | ||
| type: integer | ||
| description: The protocol field. Should always be 3. | ||
| algorithm: | ||
| type: integer | ||
| description: An 8-bit integer identifying the DNSKEY's cryptographic algorithm. | ||
| publicKey: | ||
| type: string | ||
| description: The public key material, encoded in Base64. | ||
| DSData: | ||
| type: object | ||
| required: | ||
| - keyTag | ||
| - algorithm | ||
| - digestType | ||
| - digest | ||
| properties: | ||
| keyTag: | ||
| type: integer | ||
| description: An unsigned 16-bit integer representing the key tag. | ||
| algorithm: | ||
| type: integer | ||
| description: An 8-bit integer identifying the DS record's cryptographic algorithm. | ||
| digestType: | ||
| type: integer | ||
| description: An 8-bit integer representing the type of the digest. | ||
| digest: | ||
| type: string | ||
| description: The digest value, encoded in Base64. |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.