Merge pull request #162 from Chia-Network/import-subscribe-delete-rew…

…ork-dec-2024

feat: added datamodel version storeid and hash to organization table

.gitignore

@@ -16,6 +16,9 @@ testMirror.sqlite3
 /dist
 /venv
 
+# python
+/venv
+
 # misc
 .DS_Store
 .env

docs/cadt_rpc_api.md

@@ -40,7 +40,7 @@ If using a `CADT_API_KEY` append `--header 'x-api-key: <your-api-key-here>'` to
     - [POST Examples](#post-examples)
         - [Create an organization](#create-an-organization)
     - [PUT Examples](#put-examples)
-        - [Import a home organization](#import-a-home-organization-that-datalayer-is-subscribed-to)
+        - [Import a home organization](#import-an-organization-and-subscribe-to-its-stores-on-datalayer)
     - [DELETE Examples](#delete-examples)
         - [Delete a home organization](#reset-home-organization)
     - [Additional organizations resources](#additional-organizations-resources)
@@ -220,13 +220,14 @@ Response
 
 PUT Options:
 
-|  Key   |  Type  |                     Description                      |
-|:------:|:------:|:----------------------------------------------------:|
-| orgUid | String | (Required) OrgUid of the home organization to import |
+|  Key   |  Type   |                                    Description                                     |
+|:------:|:-------:|:----------------------------------------------------------------------------------:|
+| orgUid | String  |                (Required) OrgUid of the home organization to import                |
+| isHome | Boolean | (Optional) Specify true if the specified orgUid should be imported as the home org |
 
 ### PUT Examples
 
-#### Import a home organization that datalayer is subscribed to
+#### Import an organization and subscribe to its stores on datalayer
 
 - This is typically used when an organization currently using CADT is installing a new instance and wants to use the
   same
@@ -246,20 +247,22 @@ Response
 
 ```json
 {
-  "message": "Importing home organization."
+  "success": true,
+  "message": "Successfully imported organization. CADT will begin syncing data from datalayer shortly"
 }
 ```
 
 DELETE Options: None
 
 ### DELETE Examples
 
-#### Delete home organization
+#### Delete organization
 
 Request
 
 ```sh
-curl --location --request DELETE 'http://localhost:31310/v1/organizations/'
+curl --location --request DELETE \
+'http://localhost:31310/v1/organizations/c9661d1ce77194c9e82311418aa4d370e25e10961d74d586636354746bc9ad65'
 ```
 
 Response
@@ -277,14 +280,10 @@ Response
 - POST `/organizations/sync` - runs the process to sync all subscribed organization metadata with datalayer
 - POST `/organizations/create` - create an organization without an icon
 - POST `/organizations/edit` - update an organization name and/or icon
-- PUT `/organizations/import` - subscribe and import an organization via OrgUid
-- DELETE `organizations/import` - delete an organization's record from the CADT instance DB
-- PUT `organizations/subscribe` - subscribe to an organization datalayer singleton
-- DELETE `organizations/unsubscribe` - unsubscribe from an organization datalayer singleton and keep CADT data
-- PUT `organizations/resync` - resync an organization from datalayer
-- POST `organizations/mirror` - add a mirror for a datalayer store via the store ID
-- GET `organizations/metadata` - get an organizations metadata using the OrgUid
-- GET `organizations/status` - the sync status of an organization via the OrgUid
+- PUT `/organizations/resync` - resync an organization from datalayer
+- POST `/organizations/mirror` - add a mirror for a datalayer store via the store ID
+- GET `/organizations/metadata` - get an organizations metadata using the OrgUid
+- GET `/organizations/status` - the sync status of an organization via the OrgUid
 
 ---