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 visual indicator for deprecated path parameter #245

Open
Krismix1 opened this issue Apr 23, 2023 · 0 comments
Open

Add visual indicator for deprecated path parameter #245

Krismix1 opened this issue Apr 23, 2023 · 0 comments

Comments

@Krismix1
Copy link

Krismix1 commented Apr 23, 2023

If a path parameter is marked as deprecated there is no visual indicator in the UI. I think having some indicator to be useful, as that would prevent new consumers of an API from using a field/param that is meant to be deleted.

image

Version: 0.6.4
Commit: 0beb11b
Reproduction spec (taken from the Petstore spec):

openapi: 3.0.0
servers: []
info:
  description: |
    Example
  version: 1.0.0
  title: Swagger Petstore YAML
tags:
  - name: pet
    description: Everything about your Pets
paths:
  "/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: false
          deprecated: true
          schema:
            type: integer
            format: int64
      responses:
        "200":
          description: successful operation
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/Pet"
components:
  schemas:
    Pet:
      type: object
      properties:
        name:
          description: The name given to a pet
          type: string
          example: Guru
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant