search

XeroAPI / Xero-OpenAPI

An OpenAPI description of the Xero API
https://developer.xero.com
MIT License
105 stars 125 forks source link

Schema error in Accounting OpenAPI spec #694

Open bhaeussermann opened 2 weeks ago

bhaeussermann commented 2 weeks ago

The Accounting OpenAPI specification contains a redundant "type" property. This causes an error when loading the spec using some libraries such as Graeae:

paths:
  /Accounts:
    parameters:
      - $ref: '#/components/parameters/requiredHeader'
        type: string

Expected Behavior

The spec must not report any errors in the Swagger Editor. Ideally, it shouldn't show any warnings either.

Current Behavior

When entering the Account spec the Swagger Editor reports the error "Object includes not allowed fields" on line 16.

There are also several warnings showing up.

Possible Solution

The type property must be removed from the requiredHeaders reference (line 17).

Steps to Reproduce (for bugs)

  1. Copy the Accounting spec into the Swagger Editor.
  2. Wait at least 3 minutes in order to give it time to validate the spec.

The editor reports an error "Object includes not allowed fields" on line 16.

Context

Because of the error in the spec I cannot load it using the Graeae library without making changes to the spec.

github-actions[bot] commented 2 weeks ago

PETOSS-671

github-actions[bot] commented 2 weeks ago

Thanks for raising an issue, a ticket has been created to track your request