You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+13-3Lines changed: 13 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -128,9 +128,18 @@ For help or guidance in downloading and running the application, see the followi
128
128
## Usage
129
129
This is a electron application, which means it runs on your system, rather than a browser web app (yes, electron is technically just doing what a web browser does).<br>As Such, simply install and run this application and the window will load automatically as if running an executable.
130
130
131
-
| Endpoint | Action/Desc. | Full URI <i>(hosted locally, for some port; e.g.: 3000)</i> |
| Endpoint | Action/Desc. | Full URI <i>(hosted locally, on some port; e.g.: 3000)</i> | Request Type |
132
+
|:---|:---|:---|:---|
133
+
| <ul><li>"/"</li></ul> | Empty response body, but returns a 200 status. | <ul><li>"http://localhost:3000/"</li></ul> | GET |
134
+
| <ul><li>"/listBuckets"</li></ul> | Lists all buckets that currently exist. | <ul><li>"http://localhost:3000/listBuckets"</li></ul> | GET |
135
+
| <ul><li>"/findBucket"</li></ul> | Attempt to find the passed bucket name. | <ul><li>"http://localhost:3000/findBucket?bucket=BUCKET_NAME"</li></ul> | GET |
136
+
| <ul><li>"/listObjects"</li></ul> | Lists all objects contained within a passed bucket, if the bucket exists. | <ul><li>"http://localhost:3000/listObjects?bucket=BUCKET_NAME"</li></ul> | GET |
137
+
| <ul><li>"/findObject"</li></ul> | Attempt to find passed object, in the passed bucket, if the bucket exists. | <ul><li>"http://localhost:3000/findObject?bucket=BUCKET_NAME&object=OBJECT_NAME"</li></ul> | GET |
138
+
| <ul><li>"/createBucket"</li></ul> | Create a new empty bucket, if one with the same name does not already exist. | <ul><li>"http://localhost:3000/createBucket"</li></ul> | POST |
139
+
| <ul><li>"/uploadFile"</li></ul> | Upload a local file to a specified bucket, if that bucket exists. | <ul><li>"http://localhost:3000/uploadFile"</li></ul> | POST |
140
+
| <ul><li>"/downloadFile"</li></ul> | Download a remote file from a specified bucket, if that bucket exists, and the file can be found. | <ul><li>"http://localhost:3000/downloadFile"</li></ul> | POST |
141
+
| <ul><li>"/deleteBucket"</li></ul> | Delete a passed bucket, if that bucket exists and it is empty. | <ul><li>"http://localhost:3000/deleteBucket"</li></ul> | DELETE |
142
+
| <ul><li>"/emptyBucket"</li></ul> | Empty bucket by deleting all containing objects, if the supplied bucket exists and not already empty. | <ul><li>"http://localhost:3000/emptyBucket"</li></ul> | DELETE |
134
143
135
144
<br>
136
145
@@ -165,6 +174,7 @@ Below is the refined and confirmed roadmap, that has been planned for completion
165
174
| 1.0.0 | 2021-07-10 | <ul><li>Initial Commit.</li><li>Add initial directory structure and files.</li><li>Add Screenshots directory, and images.</li><li>Create and format README.md</li></ul> |
166
175
| 1.0.1 | 2021-07-14 | <ul><li>Replace local SimpleTxtLogger with npm module SimpleTxtLogger.</li><li>Update Electron client script.</li><li>Update README.md</li></ul> |
0 commit comments