Welcome
Login
Open navigation

What information is retrieved from my Pull API via OpenAPI?

As soon as the imported OpenAPI file is valid, the API specified by the file is added to the data offering you are currently completing. A first version of this API is automatically created, with draft status.

This version includes all the information contained in the OpenAPI file: 

  • API name

  • its version

  • its URL base

  • its documentation description, links, technical contact…

  • the list of its endpoints organized in collections

Depending on the completion rate of the imported file, the version may be in configuration :

  • incomplete: the URL base is missing or in the wrong format 

  • complete 


You can view the details of each endpoint specified in the OpenAPI file by clicking on it.
Depending on the information defined in the file, you can view: 

  • a short and detailed description of the endpoint

  • an example of request

  • a scheme of the request to be sent

  • a list of response codes, with: 

    • an example response

    • the response scheme

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.