API
The OpenAPI specification focus on several areas such as enhancing usability, improving error handling, adding examples, and ensuring the documentation is clear and comprehensive.
The specification:
Detailed Operation Descriptions: Provide more context for what each endpoint does and any specific conditions or behaviors.
Examples for Parameters and Responses: Add example values and objects for both request parameters and responses to aid understanding.
Explicit Response Content: Clearly specify content types and structures for responses.
Error Handling: Define specific error codes and provide detailed messages and resolutions.
Documentation for Security: Clarify the security requirements and scope descriptions.
SwaggerHub Doc:
https://app.swaggerhub.com/apis-docs/BARKProtocol/BARK_Swap_API/0.1.0-oas3.1
Last updated