Skip to content

Commit 76f66dc

Browse files
committed
docs(bdct): explain circular references are not supported
1 parent 5b4937c commit 76f66dc

File tree

1 file changed

+1
-0
lines changed
  • website/docs/docs/bi-directional-contract-testing/contracts

1 file changed

+1
-0
lines changed

website/docs/docs/bi-directional-contract-testing/contracts/oas.md

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ When using the OpenAPI Specifications as a Provider Contract, you should know th
2727
- The OAS must be a valid YAML or JSON file. PactFlow will give an error if an invalid document is provided.
2828
- OAS documents must not be split across multiple files. You should combine the documents together, using tools like [OpenAPI Merge](https://github.com/robertmassaioli/openapi-merge) or [speccy](https://www.npmjs.com/package/speccy). That is, PactFlow can not resolve remote references to files, and will not resolve URL references.
2929
- YAML formatted OAS documents must not use [anchors](https://yaml.org/spec/1.2.2/#3222-anchors-and-aliases), due to the potential security issues (see [YAML bomb](https://en.wikipedia.org/wiki/Billion_laughs_attack) for more). If your auto-generated specs have anchors, you can pre-process them via tools like [spruce](https://github.com/geofffranks/spruce), that will expand them for you.
30+
- Circular references in schemas are not supported (see https://github.com/ajv-validator/ajv/issues/461 for additional information).
3031

3132
### Other Considerations
3233

0 commit comments

Comments
 (0)