New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Complete Documentation for APIError Enum Values #80
Comments
@JumpiiX Could you please describe how this is different than the existing documentation and links in APIError, for example app-store-server-library-java/src/main/java/com/apple/itunes/storekit/client/APIError.java Line 14 in 0913e43
|
@alexanderjordanbaker |
Problem Statement
While working with the App Store Server API and handling various errors in Swift, I noticed that the APIError enum within the App Store Server Library lacks detailed documentation for some of its values. This makes it challenging for developers to understand the context and potential solutions for the errors returned by the API.
Proposed Solution
I propose to enhance the APIError enum by adding comprehensive documentation to each enum value. This documentation will include:
A brief description of the error.
A direct link to the official Apple documentation for each specific error (where available).
Suggestions for handling these errors within apps (if applicable).
For example, for the error INVALID_IN_APP_OWNERSHIP_TYPE, the documentation could look like this:
Benefits
Next Steps
I am prepared to undertake this enhancement by completing the documentation for each enum value in the APIError class. I believe this improvement will greatly benefit the developer community by making error handling more transparent and accessible.
The text was updated successfully, but these errors were encountered: