swagger-api / swagger-api/swagger-ui

Add "required" text after asterisk on response elements

Open
#9,440 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Content & configuration

Swagger/OpenAPI definition:

  '/pet/{petId}':
   get:
     tags:
       - pet
     summary: Find pet by ID
     description: Returns a single pet
     operationId: getPetById
     parameters:
       - name: petId
         in: path
         description: ID of pet to return
         required: true
         schema:
           type: integer
           format: int64
     responses:
       '200':
         description: successful operation
         content:
           application/xml:
             schema:
               $ref: '#/components/schemas/Pet'
           application/json:
             schema:
               $ref: '#/components/schemas/Pet'
...
   Pet:
     x-swagger-router-model: io.swagger.petstore.model.Pet
     required:
       - name
       - photoUrls
     properties:
       id:
         type: integer
         format: int64
         example: 10
       name:
         type: string
         example: doggie
       category:
         $ref: '#/components/schemas/Category'
       photoUrls:
         type: array
         xml:
           wrapped: true
         items:
           type: string
           xml:
             name: photoUrl
       tags:
         type: array
         xml:
           wrapped: true
         items:
           $ref: '#/components/schemas/Tag'
           xml:
             name: tag
       status:
         type: string
         description: pet status in the store
         enum:
           - available
           - pending
           - sold
     xml:
       name: pet
     type: object

image

Is your feature request related to a problem?

It is not clear that the red asterisk on response body elements indicates a required element. The asterisk in the parameter section also includes the word "required" to make this more explicit.

Describe the solution you'd like

Add the following to swagger-ui.css:
.swagger-ui table.model tr.property-row.required td:first-child:after {
font-size: 10px;
position: relative;
top: -3px;
padding: 2px;
content: "required";
color: rgba(255,0,0,.6)
}

image

Describe alternatives you've considered
Additional context

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 in swagger-ui.css and compare the existing required styling in the parameter section with response model property rows. Add the visible “required” text after the asterisk for required response elements, then verify the Pet example shows the label beside required properties.

Written by the indexing model from the issue text.

Assessment

Tech stack
css, javascript
Domain
frontend
Issue type
Feature
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.