Skip to content

Commit

Permalink
fix: openapi to redocly cli
Browse files Browse the repository at this point in the history
  • Loading branch information
justinr1234 committed Nov 5, 2024
1 parent 9ad277d commit 3776f5c
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 1 deletion.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,20 @@ Semantic Versioning (Semver) is a versioning system that helps to avoid dependen

With a machine readable spec, AI is capable of planning and running its own queries against the XRPL. This facilitates natural language queries and responses for easier interaction with the XRPL, streamlining onboarding for new developers by providing AI-driven tutorials and guides based on the spec.

## Running docs

Install `@redocly/cli`:

```bash
npm i -g @redocly/cli
```

Run the docs preview

```bash
npm run preview
```

## Automated Testing

Creating OpenAPI and AsyncAPI specifications for the XRPL will enable us to generate automated integration tests, allowing for the testing of many more parameters than would otherwise be possible. For instance, some commands have slight variations in input parameters that result in vastly different outputs, such as returning portions of the response as JSON versus a Blob. Given all the possible combinations, it's easy to overlook tests that cover every single path. With a machine-readable specification, we can ensure that all paths and options are thoroughly tested.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"scripts": {
"template": "node addRequestTemplate.js",
"bundle": "redocly bundle open_api/json_api.yaml --output dist/openapi && node generate-specs.js",
"preview": "openapi preview"
"preview": "redocly preview"
},
"devDependencies": {
"@apidevtools/json-schema-ref-parser": "^11.7.0",
Expand Down

0 comments on commit 3776f5c

Please sign in to comment.