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

Export Requester file to OpenAPI 3 #14

Open
kylebebak opened this issue Aug 23, 2018 · 0 comments
Open

Export Requester file to OpenAPI 3 #14

kylebebak opened this issue Aug 23, 2018 · 0 comments

Comments

@kylebebak
Copy link
Owner

kylebebak commented Aug 23, 2018

We could add an open_api argument that can be passed to requests. This would be a dict containing OpenAPI properties (such as a description of the request, the request params, the response body structure, etc).

Only requests containing this argument would be included in the exported OpenAPI format.

For a request where no response body structure is specified, it might be nice to execute the actual request when the export function is run. This way the response could be parsed and used to determine the response body structure.

For properties belonging to the whole collection of requests, such as license information and so on, a special OPEN_API dict could be parsed from the env vars.

@jcberquist @keith-hall
What do you guys think? Worth adding? Interested in helping?

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

No branches or pull requests

1 participant