Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: additional documentation & examples for $ref #8

Closed
LukeHagar opened this issue Apr 6, 2024 · 1 comment
Closed

feat: additional documentation & examples for $ref #8

LukeHagar opened this issue Apr 6, 2024 · 1 comment
Labels

Comments

@LukeHagar
Copy link
Member

Examples of local and remote file references

Complex examples using file references in:

  • parameters
  • request bodies
  • error types
  • components
  • security schemas

Examples of circular file references
Shared references between multiple specifications
Examples using references in allOf, anyOf, oneOf

Best practices for using references:

  • What should the structure be of the file you are referencing?
    • for parameters
    • for request bodies
    • for error types
    • for components
    • for security schemas
  • References in arrays
  • References in discriminators
@LukeHagar
Copy link
Member Author

For inspiration:
https://swagger.io/docs/specification/using-ref/

Specifically sections like:

  • $ref Syntax
  • $ref and Sibling Elements

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant