Merge pull request #251 from stevenc987/main

Validate Names API Documentation#31631

Author: stevenc987

.github/CODEOWNERS

@@ -1,4 +1,4 @@
-* @thorwolpert @deetz99 @kris-daxiom @kialj876 @pwei1018
+* @thorwolpert @deetz99 @kris-daxiom @kialj876 @pwei1018 @stevenc987 @mengdong19 @ozamani9gh @rarmitag @hfekete @davemck513
 
 ## Business Registry
 /web/site/content/en-CA/products/br @argush3 @thorwolpert
@@ -17,8 +17,8 @@
 /web/site/public/mhr @doug-lovett
 
 ## NameX - Name Request Service
-/web/site/content/en-CA/products/namex @EPortman @thorwolpert
-/web/site/public/namex @EPortman @thorwolpert
+/web/site/content/en-CA/products/namex @thorwolpert @stevenc987 @mengdong19 @ozamani9gh @rarmitag @hfekete @davemck513
+/web/site/public/namex @thorwolpert @stevenc987 @mengdong19 @ozamani9gh @rarmitag @hfekete @davemck513
 
 ## Pay - Connect Payment Services
 /web/site/content/en-CA/products/pay @seeker25 @ochiu @jxio

web/site/content/en-CA/products/namex/overview.md

@@ -14,7 +14,7 @@ The Name Request service can be used to submit, track and manage a NameRequest.
 
 <br>
 
-::ButtonDownloadSpec{href="/namex/oas.yaml" download="xxxxx.yaml"}
+::ButtonDownloadSpec{href="/namex/namex-spec.yaml" download="namex-spec.yaml"}
 ::
 
 <br>
@@ -33,15 +33,96 @@ View the definition and select a path to try it out. To submit a request, you wi
 
 ## Fees
 
-Pending
+All fees are specified within the regulations.
+<a href="https://www.bcregistry.gov.bc.ca/product-fees" target="_blank">See our fee schedule for details</a>
 
 ---
 
 ## API Quick Reference
-
-Please refer to the online spec.
-
-This section will get populated once the release-candidate / sandbox is available.
+<table>
+  <tr>
+    <th>Endpoint Path</th>
+    <th>Description</th>
+  </tr>
+  <tr>
+    <td>GET /namex/api/v1/statistics/</td>
+    <td>
+      Get NR Processing Time (regular wait time, ​priority wait time, auto approved count).
+    </td>
+  </tr>  
+  <tr>
+    <td>POST /namex/api/v1/payments/fees</td>
+    <td>
+      Get NR Fees you must pay for a specified filing type code in Name Request.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/name-analysis/</td>
+    <td>
+      Analyze a proposed BC business name to identify structural or designation issues.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/documents:restricted_words</td>
+    <td>
+      Scan a proposed BC business name for restricted terms that are prohibited or require written consent.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/exact-match</td>
+    <td>
+      Retrieve BC business names that exactly match the provided name.    
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/requests/synonymbucket/{name}/{advanced_search}</td>
+    <td>
+      Retrieve BC business names similar to the provided name to identify potential conflicts.
+    </td>
+  </tr> 
+  <tr>
+    <td>POST /namex/api/v1/namerequests/</td>
+    <td>
+      Creates a new Name Request and returns a provisional L-number in PENDING_PAYMENT status.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/namerequests/</td>
+    <td>
+      Retrieves the details of a Name Request. Requires the NR number along with the applicant's email or phone number.
+    </td>
+  </tr> 
+  <tr>
+    <td>PATCH /namex/api/v1/namerequests/{nr_id}/{nr_action}</td>
+    <td>
+      Performs an action on a Name Request. The nr_action should be one of EDIT, CANCEL, REQUEST_REFUND.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/namerequests/{nr_id}/result</td>
+    <td>
+      Returns the Name Request results report as a PDF file. The Name Request must be in an approved, consumed, expired, or rejected state.
+    </td>
+  </tr> 
+  <tr>
+    <td>POST /namex/api/v1/payments/{nr_id}/{payment_action}</td>
+    <td>
+      Creates a payment invoice for the Name Request. The payment_action should be one of CREATE, UPGRADE, REAPPLY, RESUBMIT.
+    </td>
+  </tr> 
+  <tr>
+    <td>GET /namex/api/v1/payments/{nr_id}</td>
+    <td>
+      Retrieves all payment records from SBC Pay that are linked to the specified Name Request.
+    </td>
+  </tr> 
+  <tr>
+    <td>POST /namex/api/v1/payments/{payment_id}/receipt</td>
+    <td>
+      Generate a PDF receipt for the specified payment.
+    </td>
+  </tr>   
+</table>
 
 ---
 
@@ -62,9 +143,29 @@ All data with times are in UTC, both submitted and retrieved via the API. These
     <th>Description</th>
   </tr>
   <tr>
-    <td>TBD</td>
-    <td>0</td>
-    <td>Release Candidate</td>
+    <td>2018-06-25</td>
+    <td>0.0.0</td>
+    <td>Namex Pre-Refactor Release</td>
+  </tr>
+  <tr>
+    <td>2019-02-04</td>
+    <td>1.0.4</td>
+    <td>UI Focus Release</td>
+  </tr>
+  <tr>
+    <td>2021-07-29</td>
+    <td>1.1.0</td>
+    <td>Name Request Go-Live Enhancements Release</td>
+  </tr>
+  <tr>
+    <td>2025-02-12</td>
+    <td>1.2.21</td>
+    <td>NRO Decommision Release</td>
+  </tr>
+  <tr>
+    <td>2025-04-09</td>
+    <td>1.2.34</td>
+    <td>GCP Migration Release</td>
   </tr>
 </table>
 
@@ -92,7 +193,11 @@ Updates of note to this page are recorded here.
     <td></td>
   </tr>
   <tr>
-    <td>xxx</td>
-    <td>Release Candidate.</td>
+    <td>2025-07-15</td>
+    <td>Added Namex Api Spec</td>
+  </tr>
+  <tr>
+    <td>2026-01-18</td>
+    <td>Validated Names API Documentation</td>
   </tr>
 </table>

web/site/package.json

@@ -2,7 +2,7 @@
   "name": "developer-connect-site",
   "private": true,
   "type": "module",
-  "version": "1.1.11",
+  "version": "1.1.12",
   "scripts": {
     "build-check": "nuxt build",
     "build": "nuxt generate",

web/site/public/namex/namex-spec.yaml

@@ -59,6 +59,8 @@ paths:
                   regular_wait_time: 6.0
                   priority_wait_time: 2.0
                   auto_approved_count: 0
+        400:
+          description: Invalid response from WaitTimeStatsService
         500:
           description: Internal server error
   /namex/api/v1/payments/fees: