Sourcemeta Core 0.0.0
Loading...
Searching...
No Matches
sourcemeta::core::OpenAPIFrame::Reference Struct Reference

Public Attributes

JSON::String original
 The value as the document wrote it.
JSON::String destination
bool dangling {false}
ObjectKind expected {ObjectKind::Document}
Pointer origin

Detailed Description

Where an Object that stands in for another leads. OpenAPI Specification 3.1.1 has a Reference Object and a Path Item Object each declare at most one $ref, and a Schema Object's $ref never reaches here, so this is a field of the Object that makes it rather than a table of its own

Member Data Documentation

◆ dangling

bool sourcemeta::core::OpenAPIFrame::Reference::dangling {false}

Whether that destination is nowhere the frame holds, which is what makes a description one that has to be made whole before it describes anything

◆ destination

JSON::String sourcemeta::core::OpenAPIFrame::Reference::destination

Where it points, resolved against the base and canonicalised. The document it names and the fragment it carries are that string either side of its #, so neither is repeated here

◆ expected

ObjectKind sourcemeta::core::OpenAPIFrame::Reference::expected {ObjectKind::Document}

What the position that spells it expects to find at the far end, which OpenAPI Specification 3.1.1, Section 4.3.1 fixes by where the reference sits rather than by anything the target says about itself

◆ origin

Pointer sourcemeta::core::OpenAPIFrame::Reference::origin

Where the member that spells it sits, which is the one place a rewrite of this reference has to write to


The documentation for this struct was generated from the following file:
  • /__w/core/core/src/core/openapi/include/sourcemeta/core/openapi.h