Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Any structural or syntax issues in the API, API Version, or Proxy specification file will give results in an error in the SnapLogic UI. You can change the specifications according to the error message in the Swagger editor or any other editor tool.

Entity

Error Messages for

incorrect

Incorrect JSON or YAML (OAS2.0 or OAS3.0) Specifications

Description and Resolution

API and Proxy

Expand
titleStructural Error Message 1

Spec Contains Error

Structural error

Expecting property name enclosed in double quotes: line 33 column 29 (char 782)

Line 33

Column 29

Expand
titleInvalid or Incorrect Data Error Message 2

Spec Contains Errors

Structural error at $

'invalidField' does not match any of the regexes: '^x-'

Expand
titleInvalid or Incorrect Data Error Message 3

Spec Contains Errors

Structural error

Invalid API specification: 'str' object has no attribute 'get

  • If the API Specification

has
  • structure is incorrect structure, then the error message displays a missing path where the syntax is broken

along
  • with the line and column number.

  • If the API Specification file has incorrect or invalid data, then it specifies the incorrect data.

  • You can edit the specs in any editor such as Swagger and upload the edited specification file to create the API, API Version, or Proxy.

Example Workflow

  1. Create an API in the API Manager using with the upload option. Upload the OAS 2.0 or 3.0 YAML or JSON API Specification file:

    example-apispec.png

     

  2. If the file contains an incorrect data or has a broken broke code structure then it gives , an error occurs:

    example-error-apispec.png

     

  3. You can edit the specification file in the Swagger editor:

    example-apispec-swaggereditor.png

 

  1. After fixing all the errors in the Swagger editor are fixed, the API is successfully created with the edited API specification file. 

...