mnahkies/openapi-code-generator

Emit jsdoc based on descriptions, etc

Open

#156 opened on Apr 25, 2024

View on GitHub
 (0 comments) (0 reactions) (0 assignees)TypeScript (9 forks)auto 404
enhancementgood first issue

Repository metrics

Stars
 (34 stars)
PR merge metrics
 (PR metrics pending)

Description

Enhance developer experience by emitting jsdoc type comments using the documentation fields of the specification, to give richer information in the IDE about endpoint and fields

Contributor guide

Research direction
Examine the code generation templates and logic that produce TypeScript interfaces and types. Locate where property names and types are emitted, and add logic to also emit JSDoc comments using the 'description' field from the OpenAPI specification. Start by looking at the existing type generation code and test how descriptions are passed through.
Tech stack
typescript
Domain
backendapi
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70