OAI / learn.openapis.org

OpenAPI - Getting started, and the specification explained
https://learn.openapis.org/
Creative Commons Attribution 4.0 International
112 stars 56 forks source link

Fixing syntax of security in TicTacToe OpenAPI example #84

Closed karelhusa closed 3 months ago

karelhusa commented 6 months ago

The provided tictactoe.yaml OpenAPI example is not valid and fails to be rendered in Redocly.

Security element's type is an array. I have fixed the syntax in security of the operations.

lornajane commented 6 months ago

Thanks for spotting and fixing this @karelhusa, these should indeed be array elements.

I have one question about the security on the get-board operation though, looking at the docs it seems like the keys in security array for an operation should be reflected in the components.securitySchemes - so should this be defaultApiKey here?

handrews commented 3 months ago

PR #102 has incorporated this fix, so between that and the lack of reply for a few months I'm going to close this PR in favor of that one. But thank you for submitting it as it helped spot an error in the other PR's version of this!