Skip to content

Commit 0c90a5f

Browse files
committed
Explicitly mention the base URI for those not using jsonschema_remotes.
Closes: #364.
1 parent 79daf05 commit 0c90a5f

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

README.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -131,7 +131,11 @@ If your implementation supports multiple versions, run the above procedure for e
131131

132132
1. The suite, notably in its `refRemote.json` file in each draft, expects a number of remote references to be configured.
133133
These are JSON documents, identified by URI, which are used by the suite to test the behavior of the `$ref` keyword (and related keywords).
134-
Depending on your implementation, you may configure how to "register" these either by retrieving them from the `remotes/` directory at the root of the repository, *or* you may execute `bin/jsonschema_suite remotes` using the executable in the `bin/` directory, which will output a JSON object containing all of the remotes combined, e.g.:
134+
Depending on your implementation, you may configure how to "register" these *either*:
135+
136+
* by directly retrieving them off the filesystem from the `remotes/` directory, in which case you should resolve any `$ref` in the directory relative to a base URI of `http://localhost:1234` such that a `$ref` to `http://localhost:1234/foo/bar/baz.json` resolves to the file at `remotes/foo/bar/baz.json`
137+
138+
* or alternatively, by executing `bin/jsonschema_suite remotes` using the executable in the `bin/` directory, which will output a JSON object containing all of the remotes combined, e.g.:
135139

136140
```
137141

0 commit comments

Comments
 (0)