Skip to content

Add OpenApi 3.0 Yaml document#1229

Open
vtnerd wants to merge 1 commit intomonero-project:masterfrom
vtnerd:update/yaml_lws_spec
Open

Add OpenApi 3.0 Yaml document#1229
vtnerd wants to merge 1 commit intomonero-project:masterfrom
vtnerd:update/yaml_lws_spec

Conversation

@vtnerd
Copy link
Contributor

@vtnerd vtnerd commented Jun 29, 2025

I've mostly converted the LWS API markdown file into a OpenApi 3.0 YAML spec. We can generate more visually appealing HTML spec files this way. Additionally, all of the fields now have hard constraints on integer size, etc., and can be more tightly validated by checker tools. These tools also provide (mostly decent) JSON examples, so it should lower the barrier to getting people understanding how the spec works.

The spec includes the "drafts" for #603 #647 #1228 such that YAML document is basically complete. This also includes an additional field for /get_subaddrs which I will PR after #647 gets merged.

Some additional constraints need to be placed on since_tx_id and since_tx_block_hash such that either both are included or neither is included. Wasn't certain how to do this.

@vtnerd vtnerd force-pushed the update/yaml_lws_spec branch 5 times, most recently from c7afbef to e168646 Compare July 3, 2025 17:31
@vtnerd vtnerd force-pushed the update/yaml_lws_spec branch from e168646 to d1b3e26 Compare December 4, 2025 20:27
@vtnerd
Copy link
Contributor Author

vtnerd commented Dec 4, 2025

Force pushed the latest lookahead and /get_version specs.

@vtnerd vtnerd force-pushed the update/yaml_lws_spec branch from d1b3e26 to 6d7c7dc Compare January 19, 2026 22:21
@vtnerd
Copy link
Contributor Author

vtnerd commented Jan 19, 2026

Force pushed the draft spec for get_tree_path. This will likely change over time to include the consolidated paths approach by j-berman.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant