swagger-api / swagger-api/swagger-codegen

Dynamic html doesn't show parameter's "optional or required" info

Open
#3,240 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Client: HTML Feature: Documentation help wanted Issue: Bug
Dominant language
Mustache
Stars
17.8k
Forks
6k
PR merge metrics
No merged PRs in 30d

Description

Description

Dynamic HTML generated from swagger doesn't contain parameter's 'optional or required' information. This is present in static html.

Swagger-codegen version

Swagger 2.0

Swagger declaration file content or url
Command line used for generation
Steps to reproduce

Generate dynamic html from any template. required flag for parameters not coming.

Related issues

Static html file doesn't have tags information in it.

Suggest a Fix

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by generating dynamic HTML from a Swagger 2.0 declaration using any template, then compare it with the static HTML output. Trace how parameter metadata is rendered; done means dynamic HTML identifies whether each parameter is optional or required, matching the available static output.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.