OpenAPITools / OpenAPITools/openapi-diff

Bug: erroneous detection of changes with mediaTypes, failure to generate html/markdown reports

Abierto
#805 1 comentario 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Lenguaje dominante
Java
Estrellas
1.1k
Forks
190
Métricas de merge de PR
Sin PR fusionados en 30 d

Descripción

Hello

I've run into an interesting problem with version 2.1.2 of openapi-diff. I've redacted/dumbed down this example spec to be the smallest piece possible.
It would seem that in this case, where the content of then endpoint is uses mediaType's, changes are being detected (though not breaking) but even when the specs are identical.

I boiled the repro to the simplest form, you can take this example, put it in two separate files, and diff them with 2.1.2 (or 2.1.1 - but for instance, 2.1.0.beta-11 does NOT exhibit this)

openapi: '3.0.3'
info:
  license:
    name: ''
  termsOfService: ''
  title: "my test service"
  version: 'Latest'
tags:
  - name: mytestTag
    description: endpoints
paths:
  /v4/mytest/formats/{downloadFormat}/records/{recordId}:
    get:
      tags:
        - mytestTag
      summary: Converts record to provided format
      operationId: getV4DownloadsFormatsRecords
      deprecated: false
      x-ebsco-secured-endpoint:
        requiredScopes: [ ]
      security:
        - Authorization: [ ]
      parameters:
        - name: downloadFormat
          in: path
          description: Export format
          required: true
          schema:
            type: string
          example: 'csv'
        - name: recordId
          in: path
          description: Unique record identifier
          required: true
          example: 'ax74x2wyin'
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            text/csv:
              schema:
                type: string
                format: byte
              example: 'blah'
            application/vnd.openxmlformats-officedocument.wordprocessingml.document:
              schema:
                type: string
                format: byte
              example: 'blah'
            application/pdf:
              schema:
                type: string
                format: byte
              example: 'blah'
            application/x-bibtex:
              schema:
                type: string
                format: byte
              example: 'blah'
            application/marc:
              schema:
                type: string
                format: byte
              example: 'blah'
            text/xml:
              schema:
                type: string
                format: byte
              example: 'blah'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: 'BadRequest'
      content:
        application/json:
          example:
            name: BAD_REQUEST
            details:
              - field: '#/login/username'
                issue: BAD_REQUEST
                location: body
            debugId: '123456789'
            message: Request contains errors
            informationLink: 'http://developer.foo.com/apidoc/blah#BAD_REQUEST'
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: 'NotFound'
      content:
        application/json:
          example:
            name: NOT_FOUND
            details:
              - field: '#/login/username'
                issue: USERNAME_IS_NOT_FOUND
                location: body
            debugId: '123456789'
            message: Item is not found
            informationLink: 'http://developer.foo.com/apidoc/blah#USERNAME_IS_NOT_FOUND'
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Unauthorized:
      description: 'Unauthorized'
      content:
        application/json:
          example:
            name: UNAUTHORIZED
            details:
              - field: '#/login/username'
                issue: NOT_AUTHORIZED
                location: body
            debugId: '123456789'
            message: User is not authorized
            informationLink: 'http://developer.foo.com/apidoc/blah#NOT_AUTHORIZED'
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    Forbidden:
      description: 'Forbidden'
      content:
        application/json:
          example:
            name: FORBIDDEN
            details:
              - field: '#/login/username'
                issue: FORBIDDEN
                location: body
            debugId: '123456789'
            message: Access denied
            informationLink: 'http://developer.foo.com/apidoc/blah#FORBIDDEN'
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  schemas:
    ErrorResponse:
      type: object
      description: Common Error response
      x-examples:
        example-1:
          name: VALIDATION_ERROR
          details:
            - field: '#/login/username'
              issue: REQUIRED_FIELD_MISSING
              location: body
          debugId: '123456789'
          message: Invalid data provided
          informationLink: 'http://developer.foo.com/apidoc/blah#VALIDATION_ERROR'
  securitySchemes:
    Authorization:
      description: Authorization token
      type: http
      scheme: bearer
      bearerFormat: JWT

This will result in changes being detected, specifically around the mediaTypes

Image

So the detection of changes when the files are identical is curious.. but furthermore, attempting to generate the html or markdown version of the report fails generate with the following exception (for markdown)

Unexpected exception. Reason: Cannot invoke "org.openapitools.openapidiff.core.model.ChangedSchema.isDiscriminatorPropertyChanged()" because "schema" is null

and for html

Unexpected exception. Reason: Cannot invoke "org.openapitools.openapidiff.core.model.ChangedSchema.isIncompatible()" because "schema" is null

When running the command like so:

java -jar openapi-diff-cli-2.1.2-all.jar anothertest.yaml samefile.yaml --html blah.html --fail-on-incompatible

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

Comienza reproduciendo el informe con el YAML de OpenAPI proporcionado y el comando java -jar openapi-diff-cli-2.1.2-all.jar anothertest.yaml samefile.yaml --html blah.html --fail-on-incompatible. Inspecciona la comparación de mediaTypes y las rutas de los informes HTML/Markdown; se considera terminado cuando las especificaciones idénticas no muestran cambios y ambos formatos de informe se generan sin excepciones de puntero nulo.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
java
Área
api, cli
Tipo de issue
Error
Dificultad
3/5
Tiempo estimado
1-2 días
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
45/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.