Skip to content

Commit 0ced5f4

Browse files
committed
Clarify use of verification codes for authorizing registration.
1 parent 838c5b7 commit 0ced5f4

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -198,8 +198,8 @@ curl -X POST -L ${SEWER_RAT_URL}/register/start \
198198
```
199199

200200
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`.
203203
The body may also contain `base`, an array of strings containing the names of the files to register within the directory -
204204
if this is not provided, only files named `metadata.json` will be registered.
205205

@@ -216,6 +216,7 @@ curl -X POST -L ${SEWER_RAT_URL}/register/finish \
216216
On success, the files in the specified directory will be registered in the index.
217217
Note that SewerRat will just skip problematic files, e.g., invalid JSON, insufficient permissions.
218218
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.
219220

220221
The deregistration process is identical if we replace the `/register/*` endpoints with `/deregister/*`.
221222
The only exception is when the caller requests deregistration of a directory that does not exist.

0 commit comments

Comments
 (0)