About the OpenAPI 3 collector

Warning

This collector is in public preview. It has passed our standard testing, but it is not yet widely adopted. You might encounter unforeseen edge cases in your environment. data.world is committed to promptly addressing any issues with public preview collectors. If you face any problems, please report them through your Customer Success Director, implementation team, or support team for assistance.

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

Note

The latest version of the Collector is 2.292. 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
API	Name, Description, Terms Of Service, Document Version, Openapi Version, External Docs Description, External Docs URL
Path	Name
Schema	Name, Description, Source Text, Schema type
Schema Field	Name, Field Required, Field Type, Path
Operation	Name, Operation ID, Summary, Description, Deprecated, Operation Type
Webhook	Name
Webhook Definition	Name, Operation ID, Summary, Description, Deprecated, Operation Type
Security Scheme	Name, Security Scheme Type, Parameter Name, Key Location
Open API Tag	Name, Description, External Docs Description, External Docs URL
Operation Parameter	Name, Description, Parameter Required, Parameter Location
Response	Name, Description, Response Status Code
Request Body	Name, Description, Body Required
Payload Content	Name, Description, Media Type

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
API	Paths contained within the API Schemas used in API Security Schemes contained within the API OpenAPI tags contained within the API Webhooks contained within the API
Path	Operations contained within the Path
Schema	Schema fields contained within the Schema
Operation	Operation parameters used by the Operation Responses used by the Operation Request Bodies used by the Operation OpenApi Tags used by the Operation
Response	Payload Contents contained within the Response
Request Body	Payload Contents contained within the Request Body
Payload Content	Schemas used by the Payload Content
Webhook	Webhook definition used by Webhook
Schema	Schema Fields contained in the Schema

OpenAPI versions supported

The collector expects OpenAPI 3 specification inputs (aka swagger files) that conform to OpenAPI spec version 3.0 and 3.1. File format could be JSON or YAML.

In this section: