OpenAPITools / OpenAPITools/openapi-generator
[REQ] [Zapier] Add help text to zapier fields
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 26.8k
- Forks
- 7.7k
- PR merge metrics
- PR metrics pending
Description
Is your feature request related to a problem? Please describe.
In the Zapier schema, we can have help text to explain the usage/purpose of a field. The current Zapier generator doesn't support this feature yet.
Describe the solution you'd like
Put the description as the help text in the Zapier field.
Describe alternatives you've considered
Nope.
Additional context
The field schema of Zaiper models:
https://zapier.github.io/zapier-platform-schema/build/schema.html#fieldschema
The description is now used as the label in the Zapier model. It might conflict with the usage of help text:
https://github.com/OpenAPITools/openapi-generator/blob/063865973df48aa13da473b359faf8ed5c5d2434/modules/openapi-generator/src/main/resources/zapier/model.mustache#L32
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with modules/openapi-generator/src/main/resources/zapier/model.mustache and compare its current use of description with the Zapier FieldSchema documentation. Update the generated field mapping so the description serves as help text rather than the label, then verify the generated Zapier model output reflects both roles appropriately.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100