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

Add description field for body entries #1789

Merged
merged 4 commits into from Nov 25, 2019

Conversation

@pachisi456
Copy link
Contributor

pachisi456 commented Nov 17, 2019

Closes #1673

Besides key and value the user can provide a description to the
according body entry to better keep track of them. This is useful when
testing an API with multiple different bodies.

For now I added the description field only to the body form editor where I am thinking most people would like having it. However it could also be interesting for the url encoding editor and header editor, either by default or through an enable/disable option in the settings.

Besides key and value the user can provide a description to the
according body entry to better keep track of them. This is useful when
testing an API with multiple different bodies.
@welcome

This comment has been minimized.

Copy link

welcome bot commented Nov 17, 2019

💖 Thanks for opening this pull request! 💖

To help make this a smooth process, please be sure you have first read the
contributing guidelines.

@pachisi456 pachisi456 changed the title Add description field for body entries #1673 Add description field for body entries Nov 17, 2019
Copy link
Contributor

gschier left a comment

I'm torn on this one. I love having it here as a feature but don't like how much it cramps the UI since most people will never use it.

What do you think about this?

  • If any fields have a description, show it automatically
  • Add ability to toggle description visibility in the gear icon menu
  • Also do the same thing for urlencoded form, query, and header editors

image

@pachisi456

This comment has been minimized.

Copy link
Contributor Author

pachisi456 commented Nov 22, 2019

Thank you for your feedback!
Your suggestions make perfect sense to me. I will implement them as suggested. 👍

- Show description fields when any description exists
- Add toggle description option to gear icon menu
- Add optional description field in all key value editors
@pachisi456 pachisi456 force-pushed the pachisi456:feature/body-description-field branch from 86f2a4e to d7c2536 Nov 23, 2019
@pachisi456

This comment has been minimized.

Copy link
Contributor Author

pachisi456 commented Nov 23, 2019

Done. Let me know what you think. :)

Copy link
Contributor

gschier left a comment

Awesome! Thanks for submitting this!

@gschier gschier merged commit a25b62b into Kong:develop Nov 25, 2019
1 check was pending
1 check was pending
continuous-integration/travis-ci/pr The Travis CI build is in progress
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
2 participants
You can’t perform that action at this time.