Static ReadonlyservedThe documents the service serves. admin, the unfiltered management
document, is not one of them.
StaticaddAdds a rewritten copy. The caller's schema object is not written.
the compiler
the schema as captured
the $id to assign
component name to $id
StaticajvOne Ajv instance. A new one per compile, so a second parse does not
add the same $id twice.
the compiler
StaticcaptureStores the document's JSON and an index of it. The index is built from a parse of that JSON, so it cannot alias the caller's object.
which document this is
the builder's object
the captured model. text is JSON.stringify(document).
StaticcompileCompiles one schema. Failure is recorded on the model and returned.
strict is off because an OpenAPI schema carries keywords draft
2020 does not (example, xml).
the captured document
the schema to compile
the validator, or errors
StaticemitThe captured bytes, unchanged.
a model from capture()
the string stored at capture
StaticindexThe index. text is already the bytes.
the document name
JSON.stringify of the builder object
a parse of text
the model
StaticindexOne path item. A method the document does not use is left alone.
Any other key on the operation is vendor data and stays on the
stored document either way, because the stored document is text.
the document name
the path
the path item
the index being filled
inline response schemas
the gap list
StaticnoteRecords one compile failure, once per schema name.
the captured document
the schema
Ajv's message
StaticoperationOne operation.
the document name
the path
the HTTP method, lower case
the operation object
inline response schemas
the gap list
the index row
StaticparseChecks one value against a component schema or an inline schema. Every attribute the schema marks required stays required: unlike the directory, an API schema is a contract the document already states.
a captured document
a component name or an inline schema name
the candidate
whether it matches
StaticresponsesThe responses. A status with no schema is a gap. The schema is
stored as the document wrote it, $ref included.
the document name
the operation's id, or method and path
the operation object
inline schemas being collected
the gap list
one row per status
StaticrewriteA copy of schema whose local component refs point at $ids.
the schema as captured
component name to $id
the copy
StaticrewriteThe recursive copy rewrite() logs once around.
one node
component name to $id
the copy
StaticschemaThe $id Ajv will know this component by. An $id the schema
already carries wins.
the component name
the schema
the id
StaticschemasSchema objects on one response. A content type with no schema does not count.
one status's response object
the schemas, in content-type order, then a bare schema
Captures one OpenAPI document's bytes and indexes its operations.