docs icon indicating copy to clipboard operation
docs copied to clipboard

[Edit docs] Expand references from openapi.yaml

Open obycode opened this issue 4 months ago • 1 comments

URL of the page to change: https://docs.stacks.co/reference/api#get-v2-accounts-principal

Instead of showing:

{
  "$ref": "./components/examples/account-data.example.json"
}

there should be a way to make it expand the reference and show the actual information here. This is not very helpful as-is.

obycode avatar Sep 23 '25 18:09 obycode

gitbook is pulling this file directly from the repo. i'm not sure if it's possible to expand refs from within gitbook: https://github.com/stacks-network/stacks-core/blob/master/docs/rpc/openapi.yaml#L480 @kenrogers ?

another option would be to copy the refs into the openapi.yml file, but that would make the file really verbose. https://swagger.io/docs/specification/v3_0/using-ref/ https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.3.md#relative-references-in-urls https://gitbook.com/docs/api-references/openapi

gitbook claims to adhere to openapi 3.0 specs, i wonder if the refs need to be full URI and not relative?

wileyj avatar Sep 24 '25 17:09 wileyj