You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I have two questions around the documentation generation. Our setup seems to be somewhat unique (I'm sure there are other people doing something similar, but can't find much information online), but here's the basic synopsis of how we're using widdershins:
We have a serverless app defined in a serverless.ts file.
We're then using serverless-openapi-documentation plugin to generate an openapi.json file from our serverless.ts file.
Then we use widdershins to convert that openapi.json file to an index.html.md file in a slate directory/solution.
So my questions:
1.) I noticed how every time I open a newly generated index.html.md file, there's an # Authentication header with no content underneath. I'm trying to add a general paragraph about our authentication through api keys and can't seem to find where I would define that content for it to be pulled in for markdown generation. This may be an issue with the serverless-openapi-documentation plugin not converting something from our serverless file to our openapi file, but before I dive too deep into that, what section of the openapi file does that Authentaction section read from?
2.) If we wanted to generate other general documentation sections (ex. Troubleshooting, General Use, etc.) Where would we define those to end up in our index.html.md file?
Any help is greatly appreciated and thank you in advance!
reacted with thumbs up emoji reacted with thumbs down emoji reacted with laugh emoji reacted with hooray emoji reacted with confused emoji reacted with heart emoji reacted with rocket emoji reacted with eyes emoji
-
I have two questions around the documentation generation. Our setup seems to be somewhat unique (I'm sure there are other people doing something similar, but can't find much information online), but here's the basic synopsis of how we're using widdershins:
So my questions:
1.) I noticed how every time I open a newly generated index.html.md file, there's an
# Authentication
header with no content underneath. I'm trying to add a general paragraph about our authentication through api keys and can't seem to find where I would define that content for it to be pulled in for markdown generation. This may be an issue with the serverless-openapi-documentation plugin not converting something from our serverless file to our openapi file, but before I dive too deep into that, what section of the openapi file does that Authentaction section read from?2.) If we wanted to generate other general documentation sections (ex. Troubleshooting, General Use, etc.) Where would we define those to end up in our index.html.md file?
Any help is greatly appreciated and thank you in advance!
Beta Was this translation helpful? Give feedback.
All reactions