learn.openapis.org

learn.openapis.org copied to clipboard

Doubt with Path Parameter Validation

1

Hi, I have the following api speficiation. ``` json { "openapi": "3.0.0", "info": { "title": "API Spec With Mandatory Header and Query Parameters", "version": "1.0.0" }, "paths": { "/api-endpoint/{id}": {...

triptesh1212

oneOf or anyOf for the header schema

1

Hi community, can we define an open api 3.0 specification where the schema of a header contains oneOf or anyOf ? ``` json { "name": "apiKey", "in": "header", "required": true,...

triptesh1212

Add a page cataloging a curated list of example OpenAPI documents

2

> This issue details a thread in Slack, namely: https://open-api.slack.com/archives/C0KM0KXU6/p1710321260049639 The Petstore API has long been used as the canonical example of an OpenAPI description, partly for reasons of history...

SensibleWood

Add Callbacks, Links and Webhooks pages

5

> This work is connected to #76 Summary of changes: * Added page, diagram and example for Callback object. * Added page, diagram and example for Link object (not in...

SensibleWood

Add integer to the list of types supported by the schema object.

3

While reading, I noticed that `integer` was not included in this list of possible types. Given that `integer` is used extensively in this chapter, I assume this was a simple...

auspicacious

Index of examples to create

3

Suggestions for scenarios that we could create examples for. - Info examples - [ ] Valid Version numbers - [ ] Example License identifiers - Servers Examples - [ ]...

darrelmiller

Fixing syntax of security in TicTacToe OpenAPI example

1

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

karelhusa

Should we have more schema examples?

9

I just noted that the 3.0-RC0 specification contains no examples where `oneOf` or `anyOf` is used (maybe also `not`, that is difficult to search). Should we have some of them,...

ePaul

The SVG images contain **links to OpenAPI Specification page**, https://spec.openapis.org/oas/v3.1.0 .  Though, now the users end up at the top of the OAS page, **without navigating to the specific...

karelhusa

fix: Resize the column from just-the-docs theme

3

The security page seems to have uncovered a usability issue with the site, namely the centre column is fixed width and therefore makes the security diagram look tiny (even on...

SensibleWood