From 0ffc034b9b55d953259d0bab9661699459ad6c27 Mon Sep 17 00:00:00 2001
From: Pinga <121483313+getpinga@users.noreply.github.com>
Date: Wed, 4 Dec 2024 18:20:17 +0200
Subject: [PATCH] EPP server documentation update
---
docs/epp.md | 367 ++++++++++++++++++++++++++++++++++++++++++++--------
1 file changed, 311 insertions(+), 56 deletions(-)
diff --git a/docs/epp.md b/docs/epp.md
index a9b410f..3f8d7f9 100644
--- a/docs/epp.md
+++ b/docs/epp.md
@@ -6,7 +6,9 @@ This section includes examples of commonly used EPP commands for domains, hosts,
### 1. Session
-#### 1.1. Login Request
+#### 1.1. Login
+
+**Request:**
```xml
@@ -36,12 +38,33 @@ This section includes examples of commonly used EPP commands for domains, hosts,
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 1.2. Logout Request
+**Response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+ client-20241128-12345
+ namingo-1234567890-abcdef1234
+
+
+
+```
+
+#### 1.2. Logout
+
+**Request:**
```xml
@@ -50,11 +73,30 @@ This section includes examples of commonly used EPP commands for domains, hosts,
xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Response:**
+
+```xml
+
+
+
+
+ Command completed successfully; ending session
+
+
+ client-20241128-12345
+ namingo-1234567890-abcdef1234
+
+
+
+```
+
#### 1.3. Hello Request
```xml
@@ -75,7 +117,7 @@ This section includes examples of commonly used EPP commands for domains, hosts,
xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
- ABC-12345-XYZ
+ client-20241128-12345
```
@@ -89,7 +131,7 @@ This section includes examples of commonly used EPP commands for domains, hosts,
xsi:schemaLocation="urn:ietf:params:xml:ns:epp-1.0 epp-1.0.xsd">
- ABC-67890-XYZ
+ client-20241128-12345
```
@@ -112,14 +154,14 @@ This section includes examples of commonly used EPP commands for domains, hosts,
abc-56789
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 2.2. Contact Create Request
+#### 2.2. Contact Create
-Standard request:
+**Standard request:**
```xml
@@ -151,11 +193,38 @@ Standard request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Standard Response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+ MRG67507ad83de49
+ 2024-12-04T15:52:56.264Z
+
+
+
+ client-20241128-12345
+ namingo-1234567890-abcdef1234
+
+
+
+```
+
Request with Identica extension:
```xml
@@ -195,7 +264,7 @@ Request with Identica extension:
1234567890
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -214,12 +283,12 @@ Request with Identica extension:
abc-56789
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 2.4. Contact Update Request
+#### 2.4. Contact Update
Standard request:
@@ -253,7 +322,7 @@ Standard request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -297,7 +366,7 @@ Request with Identica extension:
1234567890
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -316,7 +385,7 @@ Request with Identica extension:
abc-12398
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -338,12 +407,14 @@ Request with Identica extension:
ns1.example.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 3.2. Host Create Request
+#### 3.2. Host Create
+
+**Request:**
```xml
@@ -358,11 +429,38 @@ Request with Identica extension:
192.0.2.1
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+ ns1.example.test
+ 2024-12-04T16:03:26.818Z
+
+
+
+ client-20241128-12345
+ namingo-1733328206-58daa6da62
+
+
+
+```
+
#### 3.3. Host Info Request
```xml
@@ -377,7 +475,7 @@ Request with Identica extension:
ns1.example.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -402,7 +500,7 @@ Request with Identica extension:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -421,16 +519,16 @@ Request with Identica extension:
ns2.example.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
### 4. Domain
-#### 4.1. Domain Check Request
+#### 4.1. Domain Check
-Standard request:
+**Standard request:**
```xml
@@ -446,12 +544,43 @@ Standard request:
example.example
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-Check for claims:
+**Standard response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+
+ example.test
+
+
+ example.example
+
+
+
+
+ client-20241128-12345
+ namingo-1733327112-3911de7da6
+
+
+
+```
+
+**Check for claims:**
```xml
@@ -473,14 +602,14 @@ Check for claims:
claims
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 4.2. Domain Create Request
+#### 4.2. Domain Create
-Standard request:
+**Standard request:**
```xml
@@ -506,11 +635,39 @@ Standard request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Standard response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+ myexample.test
+ 2024-12-04T16:06:44.813Z
+ 2025-12-04T16:06:44.813Z
+
+
+
+ client-20241128-12345
+ namingo-1733328404-9a15122064
+
+
+
+```
+
Request with DNSSEC:
```xml
@@ -555,7 +712,7 @@ Request with DNSSEC:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -596,7 +753,7 @@ Request with claims:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -635,14 +792,14 @@ Request for sunrise:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 4.3. Domain Info Request
+#### 4.3. Domain Info
-Standard request:
+**Standard request:**
```xml
@@ -659,11 +816,59 @@ Standard request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Standard response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+ myexample.test
+ D3
+ abc-56789
+ abc-12345
+ abc-12345
+ abc-12345
+
+ ns1.example.example
+ ns2.example.example
+
+ leonet
+ leonet
+ 2024-12-04T16:06:44.813Z
+ 2025-12-04T16:06:44.813Z
+
+ authInfoPw
+
+
+
+
+
+
+
+
+
+
+ client-20241128-12345
+ namingo-1733328536-2f53159160
+
+
+
+```
+
Response with Identica in database:
```xml
@@ -733,12 +938,14 @@ Response with Identica in database:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 4.5. Domain Renew Request
+#### 4.5. Domain Renew
+
+**Request:**
```xml
@@ -750,15 +957,42 @@ Response with Identica in database:
myexample.test
- 2024-10-01
+ 2025-12-04
1
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
+**Response:**
+
+```xml
+
+
+
+
+ Command completed successfully
+
+
+
+ myexample.test
+ 2026-12-04T16:06:44.813Z
+
+
+
+ client-20241128-12345
+ namingo-1733328764-f74b50827f
+
+
+
+```
+
#### 4.6. Domain Transfer Request
Request:
@@ -779,7 +1013,7 @@ Request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -799,7 +1033,7 @@ Query:
myexample.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -819,7 +1053,7 @@ Approve:
myexample.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -839,7 +1073,7 @@ Cancel:
myexample.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
@@ -859,12 +1093,14 @@ Reject:
myexample.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 4.7. Domain Delete Request
+#### 4.7. Domain Delete
+
+**Request:**
```xml
@@ -878,14 +1114,33 @@ Reject:
myexample.test
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-#### 4.8. Domain Restore Request
+**Response:**
-Request:
+```xml
+
+
+
+
+ Command completed successfully; action pending
+
+
+ client-20241128-12345
+ namingo-1733328984-1bfc0e2455
+
+
+
+```
+
+#### 4.8. Domain Restore
+
+**Request:**
```xml
@@ -903,12 +1158,12 @@ Request:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-Report:
+**Report Request:**
```xml
@@ -954,16 +1209,16 @@ Report:
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
### 5. Extensions
-#### 5.1. Funds Info Request
+#### 5.1. Funds Info
-Request:
+**Request:**
```xml
@@ -976,12 +1231,12 @@ Request:
xmlns:funds="https://namingo.org/epp/funds-1.0">
- namingo-1234567890-abcdef1234
+ client-20241128-12345
```
-Response:
+**Response:**
```xml