Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add descriptions to Open API schema #117

Open
keunes opened this issue Nov 3, 2024 · 0 comments
Open

Add descriptions to Open API schema #117

keunes opened this issue Nov 3, 2024 · 0 comments
Assignees

Comments

@keunes
Copy link
Member

keunes commented Nov 3, 2024

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 keunes self-assigned this Nov 3, 2024
@keunes keunes mentioned this issue Nov 3, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant