Skip to content

Enum value description #1316

@Giri-oss

Description

@Giri-oss

is there any provision in describing enum value while defining enum in OAI schema format

for example below status property can take values "available, pending or sold" which are defined through enum, i am looking for adding description for each of these values explaining more details about each option like when corresponding option can be used etc. same cane be picked up by API documentation tools for better documentation
status:
type: "string"
description: "pet status in the store"
enum:
- "available"
- "pending"
- "sold"
Giri

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions