Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing example when documenting parameter as content #1016

Open
lafrech opened this issue Jul 10, 2024 · 1 comment
Open

Missing example when documenting parameter as content #1016

lafrech opened this issue Jul 10, 2024 · 1 comment

Comments

@lafrech
Copy link

lafrech commented Jul 10, 2024

Hi.

I have a parameter documented as

          {
            "in": "query",
            "name": "properties",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "additionalProperties": {
                    "type": "string"
                  },
                  "example": {
                    "Min": "0"
                  }
                }
              }
            }
          },

(It is a query argument that should be a dictionary with filters as key/value to inject in a request.)

I believe this use case is legit.

In Swagger-UI, the example for this parameter reads as I expect

{
  "Min": "0"
}

In RapiDoc, it reads

[object Object]

FWIW, my API doc is OpenAPI 3.1.0.

I assume this is a use case that is not addressed yet in RapiDoc.

Is this something you would like to support?

Thanks.

Refs:

@maxiar
Copy link

maxiar commented Nov 7, 2024

Same issue ...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants