HomeGuidesAPI ReferenceChangelog
GuidesAPI ReferenceGitHubAirheads Developer CommunityLog In
Changelog
GuidesAPI ReferenceGitHubAirheads Developer Community
Back to All

API Specification Updates - OpenAPI 3.0 Compatibility Fixes

over 1 year ago by Alex Amaya

We have implemented various modifications to our API specification file to comply with OpenAPI 3.0 standards. Our objective is to enhance the readability, comprehensibility, and precision of our API specification.

Key changes include:

  1. Added missing OpenAPI 3.0 required fields: The openapi, info, servers, and paths fields were added to the root of our API specification file.

  2. Moved 'components' field: The components field was relocated from the root level to be under the openapi field, in line with OpenAPI 3.0 standards.

  3. Added 'responses' to various paths: We added a placeholder response for the 200 status code for various endpoints that were missing the responses field.

  4. Removed additional properties: In some endpoints, we removed additional properties that were not compliant with OpenAPI 3.0.

  5. Removed invalid default values: We removed invalid default values from the paths./flow.get.parameters schemas.

  6. Ensured unique operationIds: We made changes to ensure that all operationIds across the API specification are unique.

  7. Fixed invalid $ref values: We corrected several $ref values to ensure they point to valid locations in the document.

These changes should make our API specification fully compatible with OpenAPI 3.0, improving the experience for developers who are integrating with our API. As always, please consult the API documentation for full details on how to use each endpoint.