You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
If a request/response field 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 that is meant to be deleted.
I can see that the deprecated field is not included in the example request, which is already a good thing. But having something in the schema section could make it more obvious, especially for cases where the schema can have a lot of fields or to distinguish that
openapi: 3.0.0servers: []info:
description: | Exampleversion: 1.0.0title: Swagger Petstore YAMLtags:
- name: petdescription: Everything about your Petspaths:
/pet:
post:
tags:
- petsummary: Add a new pet to the storedescription: Add new pet to the store inventory.operationId: addPetresponses:
"200":
description: successful operationcontent:
application/json:
schema:
$ref: "#/components/schemas/Pet""405":
description: Invalid inputrequestBody:
$ref: "#/components/requestBodies/Pet"components:
schemas:
Pet:
type: objectproperties:
name:
description: The name given to a pettype: stringexample: Gurudeprecated: trueage:
description: The age of the pettype: numberexample: 5requestBodies:
Pet:
content:
application/json:
schema:
allOf:
- description: My Pettitle: Pettie
- $ref: "#/components/schemas/Pet"description: Pet object that needs to be added to the storerequired: true
The text was updated successfully, but these errors were encountered:
If a request/response field 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 that is meant to be deleted.I can see that the deprecated field is not included in the example request, which is already a good thing. But having something in the schema section could make it more obvious, especially for cases where the schema can have a lot of fields or to distinguish that
Version: 0.6.4
Commit: 0beb11b
Reproduction spec:
The text was updated successfully, but these errors were encountered: