Skip to main content

About the OpenAPI collector

The OpenAPI Collector gathers metadata in the OpenAPI specification format, previously known as the Swagger Specification. This collector can be used to catalog endpoints, schemas, parameters, responses, and other details found in your OpenAPI specifications.

Note

The latest version of the Collector is 2.248. To view the release notes for this version and all previous versions, please go here.

What is cataloged

The collector catalogs the following information.

Table 1.

Object

Information cataloged

Endpoint

Name

Operation

Name, description, Produces, Parameters, Responses

Parameter

Name, Description, Parameter Location, Parameter Type, Parameter Required

Response

Name, Description

Schema

Name, Description, Schema Type

Schema Property

Name, Description, Schema Property Type, Schema Format, Property Required, Schema Nullable



Relationships between objects

By default, the harvested metadata includes catalog pages for the following resource types. Each catalog page has a relationship to the other related resource types. If the metadata presentation for this data source has been customized with the help of the data.world Solutions team, you may see other resource pages and relationships.

Table 2.

Resource page

Relationship

Endpoint

  • Operations contained within Endpoint

Operation

  • Endpoint containing Operation

  • Parameters associated with Operation

  • Responses associated with Operation

Parameter

  • Operation associated with Parameter

Response

  • Operation associated with Response

  • Schema that has Response

Schema

  • Responses that are defined by Schema

  • Schema Properties that are contained within Schema

Schema Property

  • Schema that contains Schema Property



OpenAPI versions supported

  • The collector expects OpenAPI specification inputs (aka swagger files) that conform to OpenAPI spec version 2.0. OpenAPI specification 3.X is currently not supported.

In this section: