Skip to content

Commit

Permalink
fix: preview & merge conflict (#15)
Browse files Browse the repository at this point in the history
  • Loading branch information
justinr1234 authored Nov 5, 2024
1 parent 058bd46 commit 9ad277d
Show file tree
Hide file tree
Showing 3 changed files with 6,983 additions and 12,531 deletions.
6 changes: 1 addition & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,14 +185,10 @@ Semantic Versioning (Semver) is a versioning system that helps to avoid dependen

## Code Generation

<<<<<<< HEAD
- The code generator will live outside of all projects (clio , rippled, JavaScript, python, etc…). It can be written in C++, Go, a LISP language, or other languages supporting easy manipulation of Abstract Syntax Trees.
=======
1. `required` is specified at the bottom of request / response schemas by listing required fields - NOT specified in every individual field. (This makes it easier to at-a-glance see if the list of required fields are all there / what they are, but makes it slightly harder to read individual fields and know if they’re required or not).
2. In order to specify the request / response type for JSON RPC, we need to use a generic path (`/`) and a [`discriminator`](https://redocly.com/docs/resources/discriminator/) which allows us to derive the “type” of an object from the value in a specific parameter in the request. (In the case of the JSON RPC API, the `method` field tells us the type of request, which corresponds exactly with 1 or 2 response types)
- The one case where this isn’t enough information is when a request has a `binary` option - in which case there are 2 possible response structures.
- The one case where this isn’t enough information is when a request has a `binary` option - in which case there are 2 possible response structures.
3. Error responses in the "path" section represent HTTP response / errors. `rippled` or `clio` errors are treated as valid responses, and should be documented as `oneOf` the possible representations for each individual request response. Although rippled errors share a similar shape, ultimately we want to be very clear on what the specific error codes that are possible from each request.
>>>>>>> d950159 (docs updates)

- Provide flexibility for project specific behaviors while focusing on core data types and methods.

Expand Down
Loading

0 comments on commit 9ad277d

Please sign in to comment.