Skip to content

Add descriptions to Open API schema #117

Description

@keunes

The Podcast Index API specs has explanations for each field in their API explorer. That is handy; you can just use the explorer, without having to delve into the documentation.

We can also add these descriptions in the fields of response/schema definitions, and they'll show up in the explorer:

guid:
          type: string
          format: guid
          description: The unique identifier (guid) for the subscription, as declared in the feed or generated by the server

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

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