cloud-annotations / docusaurus-openapi

🦕 OpenAPI plugin for generating API reference docs in Docusaurus v2.
https://docusaurus-openapi.netlify.app
MIT License
486 stars 80 forks source link

Add visual indicator for deprecated path parameter #245

Open Krismix1 opened 1 year ago

Krismix1 commented 1 year ago

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: 0beb11b248e34e2b88f171406fc4fb04a390f065 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