Description
Currently, our OpenAPI documentation groups endpoints based on their technical implementation, such as BZZ or bytes. While this aligns with our internal code structure, it does not necessarily reflect how external developers interact with our API.
Problem Statement
Developers looking to upload or download content must explore multiple tags (BZZ, bytes, etc.) to find the relevant endpoints.
The current grouping does not reflect common use cases, making it harder to navigate.
Proposed Solution
- Reorganize OpenAPI endpoint tags based on use cases rather than internal implementation details.
- For example, Upload & Download: Include all endpoints related to uploading and downloading data, regardless of their underlying path (/bzz, /bytes, etc.).
Expected Benefits
- Improved developer experience by making it easier to find relevant API endpoints.
- More intuitive documentation for onboarding new developers.
- Clearer separation of functionality based on real-world use cases.
Next Steps
- Discuss and agree on the new categorization.
Description
Currently, our OpenAPI documentation groups endpoints based on their technical implementation, such as BZZ or bytes. While this aligns with our internal code structure, it does not necessarily reflect how external developers interact with our API.
Problem Statement
Developers looking to upload or download content must explore multiple tags (BZZ, bytes, etc.) to find the relevant endpoints.
The current grouping does not reflect common use cases, making it harder to navigate.
Proposed Solution
Expected Benefits
Next Steps