api-specs icon indicating copy to clipboard operation
api-specs copied to clipboard

Add `description`s to Open API schema

Open keunes opened this issue 1 year ago • 0 comments

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

keunes avatar Nov 03 '24 21:11 keunes