Ideas for Improvements - Githubissues

bump-sh-examples / train-travel-api

Sample OpenAPI description to use for whatever you like, as a hopefully more modern and useful alternative to the Petstore.

https://bump.sh/bump-examples/doc/train-travel-api

Other

52 stars 7 forks source link

Ideas for Improvements #3

Closed philsturgeon closed 8 months ago

philsturgeon commented 9 months ago

[x] multiple content types (6f36875)
[x] multiple examples
[x] at least one webhook (f29099f)
[x] Descriptions on tags (group description) with some markdown (16c5739)
[ ] External docs on at least one tag ? (maybe on “Bookings”)
[x] Polymorphism (anyOf)

paulRbr commented 8 months ago

[x] Descriptions on tags (group description) with some markdown (16c5739)

[ ] External docs on at least one tag ? (maybe on “Bookings”)

About markdown on description tags, could you add a bit more text with some markdown (I'm thinking of maybe one callout, a link and some bold)
Could you add an external docs link inside a tag, and maybe also one at the root level of the document?

philsturgeon commented 8 months ago

@paulRbr I have been wondering what I could link to in externalDocs? I'd like to link to something that actually exists, but we don't have any relevant guides for the API or other source of documentation that is external to this. Do you have any ideas? The GitHub Repo?

paulRbr commented 8 months ago

A link to the github repo is good yes :+1:

philsturgeon commented 8 months ago

Cool, will do that via https://github.com/bump-sh-examples/train-travel-api/issues/8