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

Postman Collection shall provide Response Examples #1068

Closed
SebastianOpriel opened this issue Oct 17, 2024 · 3 comments
Closed

Postman Collection shall provide Response Examples #1068

SebastianOpriel opened this issue Oct 17, 2024 · 3 comments
Assignees
Labels
kind/enhancement New feature or request task/documentation Improvements or additions to documentation

Comments

@SebastianOpriel
Copy link
Member

The response fields are not set. Thus, users don't know what to expect as a response from the API. Example:

@SebastianOpriel SebastianOpriel added kind/enhancement New feature or request task/documentation Improvements or additions to documentation labels Oct 17, 2024
@tmberthold
Copy link
Contributor

Hello and thank you for the hint.
However, this should be part of the OpenAPI specifications and not of the Postman Collection.
E.g. here: https://edc-ce.docs.sovity.de/backend/what-is-the-api-wrapper/openapi-specification/assets

@SebastianOpriel
Copy link
Member Author

If I import postman collection, I usually have a sample body etc. but in this case no sample as output. The postman collection could be enhanced with this. I suggest: work through all default API calls (with preset dummy values) and use output as dummy response

@tmberthold
Copy link
Contributor

Thanks for sharing these insights, as I said, this should be part of the OpenAI standard specification.
Accordingly, this is closed as not planned.

@tmberthold tmberthold closed this as not planned Won't fix, can't repro, duplicate, stale Nov 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/enhancement New feature or request task/documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants