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
+3-2Lines changed: 3 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -198,8 +198,8 @@ curl -X POST -L ${SEWER_RAT_URL}/register/start \
198
198
```
199
199
200
200
On success, this returns a `PENDING` status with a verification code.
201
-
The caller is expected to verify that they have write access to the specified directory by creating the file inside the directory with the specified code.
202
-
Once this is done, we call the `/register/finish` endpoint with a request body that contains the same `path`.
201
+
The caller is expected to verify that they have write access to the specified directory by creating a file with the same name as the verification code (i.e., `.sewer_XXX`) inside that directory.
202
+
Once this is done, we call the `/register/finish` endpoint with a request body that contains the same directory `path`.
203
203
The body may also contain `base`, an array of strings containing the names of the files to register within the directory -
204
204
if this is not provided, only files named `metadata.json` will be registered.
205
205
@@ -216,6 +216,7 @@ curl -X POST -L ${SEWER_RAT_URL}/register/finish \
216
216
On success, the files in the specified directory will be registered in the index.
217
217
Note that SewerRat will just skip problematic files, e.g., invalid JSON, insufficient permissions.
218
218
Any such problems are reported in the `comments` array rather than blocking the entire indexing process.
219
+
The verification code file can also be deleted from the directory once the registration is complete.
219
220
220
221
The deregistration process is identical if we replace the `/register/*` endpoints with `/deregister/*`.
221
222
The only exception is when the caller requests deregistration of a directory that does not exist.
0 commit comments