search

OAI / sig-moonwalk

Version 4.x of the OpenAPI Specification is known as "Moonwalk," and has a goal to ship in 2024.
https://www.openapis.org/blog/2023/12/06/openapi-moonwalk-2024
Apache License 2.0
278 stars 13 forks source link

Support SHACL schema as alternative to json-schema #118

Closed Fak3 closed 3 months ago

Fak3 commented 5 years ago

It would be nice to allow a resource to be linked with SHACL schema. So that API consumers would know a schema to validate data being sent\received. So that tools like swagger-ui would be able to render appropriate human-friendly data descriptions and playground forms validation.

Fak3 commented 5 years ago

refs OAI/OpenAPI-Specification#1100

MikeRalphson commented 5 years ago

Presumably https://www.w3.org/TR/shacl/? See also the x-oas-draft-alternativeSchema work in OAI/OpenAPI-Specification#1532 which allows this to be supported today.

Fak3 commented 4 years ago

What is the process to add a new alternative schema to this registry: https://spec.openapis.org/registry/alternative-schema/ ?

MikeRalphson commented 4 years ago

As you can probably see, the registry you linked to is still in draft state so the data points are all just examples for now.

That said, the proposed process for adding a registry value should be along the lines of the example PR OAI/OpenAPI-Specification#1811 though the github PR template is not yet set up.