Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
hgiasac committed Nov 11, 2024
1 parent 48a4615 commit 37281d5
Showing 1 changed file with 13 additions and 1 deletion.
14 changes: 13 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ The connector can automatically transform OpenAPI 2.0 and 3.0 definitions to NDC
![REST connector](./assets/rest_connector.png)

> [!NOTE]
> REST connector is configuration-based and isn't limited to the OpenAPI specs only. Use [OpenAPI Connector](https://hasura.io/docs/3.0/connectors/external-apis/open-api) if you want to take more control of OpenAPI via code generation.
> REST connector is configuration-based HTTP engine and isn't limited to the OpenAPI specs only. Use [OpenAPI Connector](https://hasura.io/docs/3.0/connectors/external-apis/open-api) if you want to take more control of OpenAPI via code generation.
## Quick start

Expand Down Expand Up @@ -139,6 +139,18 @@ files:

You can add JSON patches to extend API documentation files. REST connector supports `merge` and `json6902` strategies. JSON patches can be applied before or after the conversion from OpenAPI to REST schema configuration. It will be useful if you need to extend or fix some fields in the API documentation such as server URL.

```yaml
files:
- file: openapi.yaml
spec: oas3
patchBefore:
- path: patch-before.yaml
strategy: merge
patchAfter:
- path: patch-after.yaml
strategy: json6902
```

See [the example](./ndc-rest-schema/command/testdata/patch) for more context.

## Distributed execution
Expand Down

0 comments on commit 37281d5

Please sign in to comment.