GithubHelp home page GithubHelp logo

Comments (5)

ahx avatar ahx commented on June 10, 2024

I think you are looking for uri-reference not uri https://json-schema.org/understanding-json-schema/reference/string

from openapi_first.

neongrau avatar neongrau commented on June 10, 2024

Not really. The field usually refers to an S3 URL. But if not set, it defaults to a local placeholder. I could change to an absolute URL though OpenAPI says the local relative URL is good.

from openapi_first.

ahx avatar ahx commented on June 10, 2024

I think you are are right. I have tried two (1, 2) other schema validation libraries and they indeed seem to behave differently from json_schemer in this case.

irb(main):004> JSONSchemer.schema({'type' => 'string', 'format' => 'uri' }, meta_schema: 'https://spec.openapis.org/oas/3.1/dialect/base').valid?('/data/foo/bar')
=> false

irb(main):006> JSONSchemer.schema({'type' => 'string', 'format' => 'uri-reference' }, meta_schema: 'https://spec.openapis.org/oas/3.1/dialect/base').valid?('/data/foo/bar')
=> true

I am not json_schemer is wrong here, though since this section of the JSON Schema spec does not really clarify things for me.

from openapi_first.

neongrau avatar neongrau commented on June 10, 2024

Hmm odd, but i think ChatGPT summed it up nicely:

URI (format: uri): The uri format specifies that a string attribute represents a Uniform Resource Identifier (URI). However, it doesn't specify whether relative paths are allowed or not. It's up to the interpretation of the attribute's value and the context in which it's used. In practice, many implementations of OpenAPI treat uri as a broad category that includes both absolute and relative URIs, but this isn't strictly enforced by the specification.

URI-Reference (format: uri-reference): The uri-reference format specifically allows URI references, which can include both absolute and relative URIs, as well as fragment identifiers. This format is suitable when you want to allow a broader range of URI-like values, including relative paths, in your attribute.

Well going to switch everything to uri-reference to be safe then.

from openapi_first.

neongrau avatar neongrau commented on June 10, 2024

Just ran across this https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#relative-references-in-urls

from openapi_first.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.