Giter Site home page Giter Site logo

Comments (2)

ralpha avatar ralpha commented on September 3, 2024

They are both correct according to the spec.
The examples can lists multiple example values. The example (notice the missing s) can denote only one example value.
Screenshot from 2022-10-12 13-54-36
Source: https://spec.openapis.org/oas/latest.html#fixed-fields-9

If there is something else I'm missing, let me know.

from okapi.

build2stone avatar build2stone commented on September 3, 2024

Sorry for not including this info from the beginning.
I've put my example code here: https://github.com/build2stone/okapi_examples
It prints the following spec:

{
  "openapi": "3.0.0",
  "info": {
    "title": "okapi_examples",
    "version": "0.1.0"
  },
  "paths": {
    "/example": {
      "get": {
        "operationId": "get_param",
        "parameters": [
          {
            "name": "param",
            "in": "query",
            "required": true,
            "schema": {
              "examples": [
                10
              ],
              "type": "integer",
              "format": "int32"
            }
          }
        ],
        "responses": {
          "200": {
            "description": ""
          }
        }
      }
    }
  },
  "components": {}
}

The problem here is that using examples inside a schema object is only supported in v3.1.0, not v3.0.0 (the purported version):
https://spec.openapis.org/oas/v3.0.0#fixed-fields-19
vs
https://spec.openapis.org/oas/v3.1.0#fixed-fields-19

examples directly within the parameter object is supported in both versions, but appears unrelated.

from okapi.

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.