Skip to content

Commit bf1d6b4

Browse files
committed
docs: note OpenAPI remote ref behaviour change in v5 upgrade guide
1 parent 16a861a commit bf1d6b4

1 file changed

Lines changed: 10 additions & 0 deletions

File tree

docs/upgrade_v5.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -160,6 +160,16 @@ path: /api/:version/users/:id
160160
path: /api/{version}/users/{id}
161161
```
162162

163+
## OpenAPI remote schema references
164+
165+
In Imposter 4, the JVM engine resolved remote OpenAPI `$ref` references (over HTTP) at load time. In Imposter 5, remote reference resolution is **disabled by default**, because outbound HTTP from a mock server is undesirable in locked-down environments.
166+
167+
If your OpenAPI specifications rely on remote `$ref` resolution, you must explicitly opt in:
168+
169+
```shell
170+
IMPOSTER_OPENAPI_ALLOW_REMOTE_REFS=true
171+
```
172+
163173
## Legacy configuration support
164174

165175
If you want to use your existing Imposter 4 configuration files without modifying them, you can enable legacy configuration support by setting the following environment variable:

0 commit comments

Comments
 (0)