quarkus-logging-manager icon indicating copy to clipboard operation
quarkus-logging-manager copied to clipboard

open-api warnings

Open ChMThiel opened this issue 4 years ago • 3 comments

Hello, my swagger-ui shows warnings:

{
  "messages": [
    "attribute paths.'/q/logging-manager'(get).responses.200.description is missing",
    "attribute paths.'/q/logging-manager/levels'(get).responses.200.description is missing"
  ],
  "schemaValidationMessages": [
    {
      "level": "error",
      "domain": "validation",
      "keyword": "oneOf",
      "message": "instance failed to match exactly one schema (matched 0 out of 2)",
      "schema": {
        "loadingURI": "#",
        "pointer": "/definitions/Components/properties/securitySchemes/patternProperties/^[a-zA-Z0-9\\.\\-_]+$"
      },
      "instance": {
        "pointer": "/components/securitySchemes/keycloak_auth"
      }
    }
  ]

in my application.properties i define following security for log-manager

quarkus.logging-manager.openapi.included=true
quarkus.http.auth.policy.logging-policy.roles-allowed=technical_admin
quarkus.http.auth.permission.logging.paths=/q/logging-manager/*
quarkus.http.auth.permission.logging.policy=logging-policy

the logging-part of the swagger.json is at follows

/q/logging-manager:
    summary: "Return info on all loggers, or a specific logger"
    description: Logging Manager Loggers
    get:
      tags:
      - system info (private)
      summary: Information on Logger(s)
      description: Get information on all loggers or a specific logger.
      operationId: logging_manager_get_all
      parameters:
      - name: loggerName
        in: query
        schema:
          type: string
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListLoggerInfo'
        "404":
          description: Not Found
    post:
      tags:
      - system info (private)
      summary: Update log level
      description: Update a log level for a certain logger
      operationId: logging_manager_update
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                loggerLevel:
                  $ref: '#/components/schemas/LoggerLevel'
                loggerName:
                  $ref: '#/components/schemas/LoggerName'
      responses:
        "201":
          description: Created
  /q/logging-manager/levels:
    summary: Return all levels that is available
    description: 'All available levels '
    get:
      tags:
      - system info (private)
      summary: Get all available levels
      description: This returns all possible log levels
      operationId: logging_manager_levels
      responses:
        "200":
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListString'{
  "messages": [
    "attribute paths.'/q/logging-manager'(get).responses.200.description is missing",
    "attribute paths.'/q/logging-manager/levels'(get).responses.200.description is missing"
  ],
  "schemaValidationMessages": [
    {
      "level": "error",
      "domain": "validation",
      "keyword": "oneOf",
      "message": "instance failed to match exactly one schema (matched 0 out of 2)",
      "schema": {
        "loadingURI": "#",
        "pointer": "/definitions/Components/properties/securitySchemes/patternProperties/^[a-zA-Z0-9\\.\\-_]+$"
      },
      "instance": {
        "pointer": "/components/securitySchemes/keycloak_auth"
      }
    }
  ]


All swagger-ui works as far as i can see, even authorization for the log-manager apis. It's just a warning at the bottom of the swagger-page. We are using quarkus 1.13.6.Final and logging-manager 1.1.3

ChMThiel avatar Jul 16 '21 07:07 ChMThiel

Can you share your pom ? Or at least the dependencies ? Thanks

phillip-kruger avatar Jul 26 '21 14:07 phillip-kruger

Hi @ChMThiel - I can not seem to recreate your issue. Can you provide a reproducer ? Or modify https://github.com/phillip-kruger/logging-manager-example to highlight the issue

phillip-kruger avatar Jul 26 '21 15:07 phillip-kruger

Hi Philipp,

I'm currently on vacation. I will forward youre request to a collegue. In two weeks i'm back in the Office.

Best regards,

Christian

Phillip Krüger @.***> schrieb am Mo., 26. Juli 2021, 17:00:

Hi @ChMThiel https://github.com/ChMThiel - I can not seem to recreate your issue. Can you provide a reproducer ? Or modify https://github.com/phillip-kruger/logging-manager-example to highlight the issue

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/quarkiverse/quarkus-logging-manager/issues/88#issuecomment-886779103, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQZ57NOVJCGZWTPSGGRM253TZV2BLANCNFSM5APCEA3A .

ChMThiel avatar Jul 26 '21 15:07 ChMThiel