Skip to contents

Get schema references

Source: R/schema_docs.R
get_ref.Rd

Parses $ref calls in a schema. Can retrieve internal ('"$ref":"#/definitions/someDef") or external references ('"$ref":"schemas/datacite/datacite.json"').

Usage

get_ref(x, schema_dir)

Arguments

x

List. Must have property "$ref"

schema_dir

Character. Directory for the current schema.

Value

List or Character. Character is only returned if an entire schema is referenced.

Details

For external references, it can handle both pointers and references to entire schemas. This function navigates between parent and child schemas by manipulating variables in the package environment the.

See also

Other Schema Docs: create_object_docs(), create_schema_docs(), get_required_fields(), increase_docs_depth(), paste_reduce(), paste_reduce_ul()