srch

Oneof vs. Anyof

Using the OpenAPI discriminator ... When an API can return two or more different types of objects (aka polymorphism), use oneOf or anyOf to describe those schemas ...

Feb 18, 2021 · SAN FRANCISCO – February 18, 2021 – The OpenAPI Initiative, the consortium of forward-looking industry experts focused on creating, evolving and promoting the OpenAPI Specification (OAS), a vendor-neutral, open description format for HTTP (including RESTful) APIs, announced today that the OpenAPI Specification 3.1.0 has been released.

For example, a valid OpenAPI 3.0.2 document, upon changing its openapi property to 3.1.0 , SHALL be a valid OpenAPI 3.1.0 document, semantically equivalent ...

This begs the question: now that 3.0 supports a large-enough subset of JSON Schema to describe discriminated subtypes, and 3.1 is planned to support full JSON Schema, do we still need discriminator? @handrews mentions the same idea here in #2031 , so I think the idea deserves its own issue for future version planning.

17.10.2019 · Hi, Firstly, congratulations for your tool. It is really the best viewer that I could have used! From redoc v2.0.0-rc.18, I have a problem with discriminator & mapping fields of OpenAPI 3 Indeed, below, we can see my screenshot from the ...

3.1 OpenAPI Document; 3.2 Path Templating; 3.3 Media Types; 3.4 HTTP Status Codes. 4. Specification ... 4.8.25 Discriminator Object.

1 focus on solving JSON Schema compatibility fully, and forever, with a perfectly compatible change in wording in the 3.1.0.md Markdown file.

26.01.2018 · MikeRalphson commented Jul 31, 2020. In JSON Schema draft 2019-09 and therefore in OAS 3.1, format is an annotation, not by default, a constraint so the utility of a list or registry of approved formats is somewhat diminished. It may be better to use minimum and maximum constraints instead of (u)intXX formats going forward.

Dec 08, 2021 · The OpenAPI 3.1 Schema dialect. By default, schemas in OpenAPI 3.1 are assumed to use OpenAPI 3.1's custom JSON Schema dialect. This dialect includes full support for all draft 2020-12 features plus a few additional keywords and format values. Validating with the default dialect. There are two schemas available for validating OpenAPI 3.1 documents.

The discriminator is a specific object in a schema which is used to inform the consumer of the document of an alternative schema based on the value associated ...

By default, you get the OpenAPI 3.1 Schema dialect, ... understand the keywords added in the OpenAPI 3.1 vocabulary such as discriminator .

OpenAPI Specification Version 3.1.0 Introduction Table of Contents Definitions OpenAPI Document Path Templating Media Types HTTP Status Codes Specification Versions Format Document Structure Data Types Rich Text Formatting Relative References in URIs Relative References in URLs Schema OpenAPI Object Fixed Fields Info Object Fixed Fields Info Object …

This begs the question: now that 3.0 supports a large-enough subset of JSON Schema to describe discriminated subtypes, and 3.1 is planned to support full JSON Schema, do we still need discriminator? @handrews mentions the same idea here in #2031 , so I think the idea deserves its own issue for future version planning.

I recommend asking this question in the OpenAPI specification repository github.com/OAI/OpenAPI-Specification/issues - maybe the new OpenAPI 3.1 ...

21.04.2020 · Description When I generate client libs for an OpenAPI 3.0.1 YAML, discriminator settings are ignored in the generated JSON deserialisation code. This means when deserialising JSON we can't enf...

For example, a valid OpenAPI 3.0.2 document, upon changing its openapi property to 3.1.0, SHALL be a valid OpenAPI 3.1.0 document, semantically equivalent to the original OpenAPI 3.0.2 document. New minor versions of the OpenAPI Specification MUST be written to ensure this form of backward compatibility.

Tooling which supports OAS 3.1 SHOULD be compatible with all OAS 3.1.* versions. The patch version SHOULD NOT be considered by tooling, making no distinction between 3.1.0 and 3.1.1 for example. Occasionally, non-backwards compatible changes may be made in minor versions of the OAS where impact is believed to be low relative to the benefit ...

Not sure if this is a bug or if the OpenAPI 3 specification just allows this. When I use discriminator with a specific mapping then prism does not correctly ...

08.12.2020 · Discriminator in OpenApi 3. Ask Question Asked 1 year ago. Active 1 year ago. Viewed 262 times 1 In the OpenAPI documentation there is example of using discriminator. components: responses ...

An OpenAPI document that conforms to the OpenAPI Specification is itself a JSON object, which may be represented either in JSON or YAML format. For example, if a field has an array value, the JSON array representation will be used: { "field": [ 1, 2, …

18.02.2021 · OpenAPI Specification 3.1.0 Released. OpenAPI developer community and JSON Schema community work together to build upgrade that supports 100% compatibility with the latest draft of JSON Schema. SAN FRANCISCO – February 18, 2021 – The OpenAPI Initiative, the consortium of forward-looking industry experts focused on creating, evolving and ...

OAS 3 This guide is for OpenAPI 3.0.. Inheritance and Polymorphism Model Composition In your API, you may have model schemas that share common properties. Instead of describing these properties for each schema repeatedly, you can describe the schemas as a composition of the common property set and schema-specific properties.

Though this is optional under OpenAPI 3.1, since we currently don't support webhooks or API definitions with just components you must have