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

Inconsistent data type rendering #1009

Open
meyer-r opened this issue Apr 29, 2024 · 0 comments
Open

Inconsistent data type rendering #1009

meyer-r opened this issue Apr 29, 2024 · 0 comments

Comments

@meyer-r
Copy link

meyer-r commented Apr 29, 2024

The representation of data types is inconsistent for path parameters and response objects:

In the following sample OpenAPI, a path parameter and a response object property are both defined with type:integer and format:int64.

Sample OpenAPI:

openapi: 3.0.1
info:
  title: demo
  version: 0.0.1
paths:
  /service/{id}:
    get:
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        200:
          description: response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: integer
                    format: int64

While Rapidoc renders "int64" for the path parameters (which seems fine as int64 implies integer type), it shows "integer" for the response object property (see the following screenshot, type information marked green):

rapidoc-format-missing

This is confusing, as the user will assume that the parameter and property have different data types, which is not the case.
Data type information should be rendered uniformly including format details in all places.

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

1 participant