learn.openapis.org
learn.openapis.org copied to clipboard
Outstanding items to include
From #1
- [ ] Callbacks and Webhooks [Advanced]: What’s the difference, with examples. #76
- [ ] Schemas [Advanced]: examples for schemas, responses and parameters.
- [ ] Security [Advanced]:
securitySchemeandsecurity.
@MikeRalphson as per on Slack message I'm happy to pick up Security above based on the content I'm producing for the OAI training course. Let me know if that helps at all - and if work is not already in progress somewhere - and if so please can we split into a separate ticket.
Thanks @SensibleWood , I'm pretty confident the work is not already in progress somewhere so we'd be more than happy for you to contribute! If you want to create an issue for what you're working on and assign it to yourself, that will also make it clearer for anyone else wanting to do the same thing.
We don't have detailed writing guidelines here, so take a look at what we have already and try to blend your knowledge in? Thanks for helping!
Nice one @lornajane I will make it so right now
I've noticed something missing from the examples and I'm wondering if this open item would be the place to address it.
I have a case where a parameter is an array whose items point to a $ref, like this:
paths:
/test:
get:
operationId: getTest
parameters:
- in: query
name: test
schema:
items:
$ref: '#/components/schemas/Test'
type: array
Would this be suitable under the open to-do for Schemas [Advanced]: examples for schemas, responses and parameters?
@njbair Would you like to create a pull request adding an example with an array parameter whose items are defined by a Reference Object?
@njbair Would you like to create a pull request adding an example with an array parameter whose items are defined by a Reference Object?
@ralfhandl I would be happy to. I'm sure there are other advanced cases that could be addressed in the same example, but I'll start simple and folks can always add more later.
I'll start working on a PR shortly.