update documentation to deprecate ETOR NBS integration (#17146)

CDCgov · Jan 24, 2025 · 91a6c30 · 91a6c30
1 parent 1e0e737
commit 91a6c30
Show file tree

Hide file tree

Showing 3 changed files with 4 additions and 0 deletions.
diff --git a/prime-router/docs/api/delivery.yml b/prime-router/docs/api/delivery.yml
@@ -43,6 +43,7 @@ paths:
           description: The receiver could not be found
   /waters/report/{reportId}/delivery/etorMetadata:
     get:
+      deprecated: true
       summary: Retrieves ETOR metadata for a recipient's report
       description: Fetches the ETOR intermediary's metadata given the recipient's report ID.
       operationId: getEtorMetadataForDelivery

diff --git a/prime-router/docs/api/submissions.yml b/prime-router/docs/api/submissions.yml
@@ -168,6 +168,7 @@ paths:
           description: Internal Server Error
   /waters/report/{reportId}/history/etorMetadata:
     get:
+      deprecated: true
       summary: Retrieves ETOR metadata for a sender's report
       description: Fetches the ETOR intermediary's metadata given the sender's report ID.
       operationId: getEtorMetadataForHistory

diff --git a/prime-router/docs/docs-deprecated/getting-started/getting-started.md b/prime-router/docs/docs-deprecated/getting-started/getting-started.md
@@ -307,6 +307,8 @@ PRIME_DATA_HUB_INSECURE_SSL=true docker compose build
 
 ## `ETOR_TI_baseurl` service setup
 
+> WARNING: This project has been paused. This documentation remains in case it is brought back.
+
 To run the service associated with this environment variable locally, please visit the instructions located 
 [at the intermediary project](https://github.com/CDCgov/trusted-intermediary/blob/main/README.md)