forked from deliveryhero/serverless-aws-documentation
-
Notifications
You must be signed in to change notification settings - Fork 13
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
Incorrect documentation preview when template contains a $ref #45
Comments
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 20, 2024
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 21, 2024
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 25, 2024
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 25, 2024
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 25, 2024
rovellipaolo
added a commit
to rovellipaolo/serverless-aws-apigateway-documentation
that referenced
this issue
Mar 26, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
When generating a documentation preview locally, with
serverless generateDocumentation
command, the documentation will not be generated correctly if the template contains a reference to another local model with the$ref
keyword.For example the following template (taken directly from the
README.md
file):will generate the following documentation preview:
As you can see the
$ref
value is"{{model: Address}}"
(wrong) rather than"#/components/schemas/Address"
(correct).NOTE: The documentation preview will be generated correctly if the reference is to a URL (e.g.,
"http://path/to/your/resource"
).Although it's expected that the documentation preview might potentially be invalid or anyway different from the final documentation (which is why it's called "preview"), it would be nice to fix this use-case.
The text was updated successfully, but these errors were encountered: