OpenAPI-Specification

OpenAPI-Specification copied to clipboard

Usage of `field` vs `property`

7

I was wondering if authors of the spec would be open to make usage of `field` and `property` somehow consistent. When we have specification objects we refer to it's properties...

char0n

Preserve section links in ReSpec output

1

Direct links to RFC sections are useful, for example in https://github.com/OAI/OpenAPI-Specification/blob/3f2e047df0df5e264374a2a1aa6586a3d899ceed/versions/3.1.0.md?plain=1#L1056-L1059. Unfortunately these currently get lost when running the Markdown sources through ReSpec and result in unspecific `#bib-RFC6570` links, see...

ralfhandl

Add dark mode support to the HTML versions of the OpenAPI specs

5

Update the rendering process for the HTML versions of the OpenAPI specs (using ReSpec) to generate pages that support dark mode. ReSpec has added dark mode support: https://github.com/speced/respec/issues/2651 Related: #3576

mikekistler

We should not keep a minified version of respec.js

1

## Problem There are 2 minified versions of `respec.js` for 3.x and for 4.x versions. These files exists in the `gh-pages`: 1. `/js/respec-oai.js` 2. `/js/respec-arrazzo.js` These files are basically unmaintainable...

Bellangelo

Add example/s as "Operation Request" child

6

To define valid parameter **combination** examples, it would be nice to define consistent examples for an operation and not only on JSON / single-parameter base. The alternative to use the...

chatelao

`primaryData` attribute in Media Type Object

4

[Media Type Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#mediaTypeObject) should have an optional `primaryData` attribute, to specify the name of the property, where the primary data is located in the schema. It is very common to...

K-Adam

Consolidated $ref-to-Some Object feature request

6

This issure consolidates and replaces the numerous "can the OAS allow `$ref` for..." issues: * Security Requirement: #1850 * Security Scheme: #1972 (but see also #3776 for an alternative) *...

handrews

OIDC auth and token enpoints to support enironments like servers section does

2

Servers section allows for multiple urls's however oidc only allows a single oidc server

mcrobbj

Inconsistent usage of quotes in yaml examples

9

This is a minor nitpick but as someone unfamiliar with the OpenAPI specifcation and yaml until now, I found it confusing at first. There is inconsistent usage of quotes in...

ndjensen

Add 'name' field to servers

3

As the name suggests. Would be nice, I think, for generators to be able to reference them by non-ambiguous names.

BelfordZ