API Reference

OpenAPI Specification and Swagger UI


This documentation provides a detailed guide on how to visualize and interact with the Open Data Discovery (ODD) API. It covers the usage of the OpenAPI Specification for understanding the API's structure and Swagger UI for testing and interacting with the API endpoints

OpenAPI Specification

The Platform has 2 distinct specifications that serve different aspects and both adhere to the OpenAPI Specification:

  1. Ingest specification: An open standards specification that unifies metadata formats and allows multiple data sources and participants of the data discovery landscape to exchange metadata effectively, transparently, and consistently. It describes the semantics of the data discovery process as we envision it. It is data source agnostic by design and is intentionally not tied to the specifics of any particular data source or data catalog. Reference to the description of the specification: https://github.com/opendatadiscovery/opendatadiscovery-specification/blob/main/specification/specification.md.

  2. Platform specification: This specification outlines the available endpoints, request methods, response codes, and other necessary details to interact with objects within ODD Platform. The full OpenAPI Specification for the ODD API can be accessed at GitHub Repository OpenAPI Specification.

Using the Swagger UI

You can utilize the Swagger UI for an interactive experience with the ODD API.

Swagger UI Access: The Swagger UI can be accessed on your deployed ODD platform at {platform-base-url}/api/v3/api-docs. Additionally, a demo version is available at ODD Platform Demo Swagger UI.

Interacting with the API via Swagger UI

Select a definition: There are two definitions:

  • ingestion-api: describes all ingestion endpoints that are used by collectors.

  • platform-api: describes all endpoints for the ODD platform, that can be used to access ODD resources.

Start a Request: Navigate to an API endpoint in the Swagger UI and click "Try it out".

Enter Required Information: Ensure all mandatory fields (marked with an asterisk *) are completed.

Send the Request: Click the “Execute” button to submit the request.

Responses in Swagger UI

  • Response Body: The API response will be shown in the "Response body" section.

  • Response Codes and Examples: Examples of response objects for each response code can be found in the "Responses" section.

Further Information

Learn more about how to use Swagger UI with the Swagger UI documentation.

Last updated