learn.openapis.org icon indicating copy to clipboard operation
learn.openapis.org copied to clipboard

Outstanding items to include

Open MikeRalphson opened this issue 2 years ago • 6 comments

From #1

  • [ ] Callbacks and Webhooks [Advanced]: What’s the difference, with examples. #76
  • [ ] Schemas [Advanced]: examples for schemas, responses and parameters.
  • [ ] Security [Advanced]: securityScheme and security.

MikeRalphson avatar Apr 25 '23 16:04 MikeRalphson

@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.

SensibleWood avatar Jan 05 '24 07:01 SensibleWood

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!

lornajane avatar Jan 05 '24 08:01 lornajane

Nice one @lornajane I will make it so right now

SensibleWood avatar Jan 05 '24 08:01 SensibleWood

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 avatar Sep 10 '24 18:09 njbair

@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 avatar Sep 11 '24 09:09 ralfhandl

@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.

njbair avatar Sep 11 '24 13:09 njbair