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

ReDoc shows warning for valid OpenAPI file #214

Open
Glurz opened this issue Jan 5, 2021 · 0 comments
Open

ReDoc shows warning for valid OpenAPI file #214

Glurz opened this issue Jan 5, 2021 · 0 comments
Labels

Comments

@Glurz
Copy link

Glurz commented Jan 5, 2021

Describe the bug

When generating a ReDoc documentation for a very simple, valid OpenAPI YAML file (given below), ReDoc shows the following warning:

Warning: No "type" specified at "/paths/~1poc~1users~1{userId}~1tokens~1fido~1credentials~1/get/parameters/0". Automatically detected: "object"

What version of ReDoc is built into your gradle plugin? Is it maybe too old to handle openapi 3.0.3?
I'm using org.hidetake.swagger.generator 2.18.2 and io.swagger.codegen.v3:swagger-codegen-cli:3.0.23

To Reproduce:

Generate the ReDoc documentation for the YAML below:

openapi: 3.0.3
info:
  title: FIDO Credentials OpenAPI PoC
  version: 1.2.3
paths:
  '/poc/users/{userId}/tokens/fido/credentials/':
    get:
      operationId: listFidoCredentials
      tags:
        - fidoPoc
      summary: Retrieves all of a user's FIDO credentials.
      description: A longer description of this endpoint.
      parameters:
        - name: userId
          description: The ID of the user.
          in: path
          required: true
          schema:
            type: string
      responses:
        '204':
          description: The list of FIDO credentials of the specified user.

Expected behavior:
The rendered ReDoc does not show warnings.
The problem does not occur if I build the documentation with a stand-alone version of ReDoc (0.10.1).

Environment

Plugin version: 2.18.2
Swagger Codegen version: 3.0.23
Gradle version: 6.7
Java version: 11
OS: macOS

@Glurz Glurz added the bug label Jan 5, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant