Skip to content
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

[Documentation] Clarify credit field usage in APOD API #107

Open
StellarStoic opened this issue May 20, 2023 · 1 comment
Open

[Documentation] Clarify credit field usage in APOD API #107

StellarStoic opened this issue May 20, 2023 · 1 comment

Comments

@StellarStoic
Copy link

Description:

This pull request aims to address a gap in the documentation regarding the credit field in the APOD API responses.

During the usage of the APOD API, it was noticed that sometimes the copyright field is not present and a field named credit appears to be in its place. This was not documented in the current API guide, leading to potential misunderstandings and errors when developers attempt to access the copyright or credit field.

Changes Proposed:

Add documentation to the APOD API guide clarifying the usage and conditions of the credit field.
Provide examples in the API guide of responses that might contain the credit field instead of the copyright field.
Update any existing examples in the documentation that refer to the copyright field, noting that credit may sometimes be present instead.
By providing this additional clarity around the credit field in the APOD API documentation, we can help developers avoid unexpected errors and better handle the variability in the API responses.

@Dan-Banfield
Copy link

Agreed. Experienced this issue myself.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants