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

Add Swagger API documentation and add data ingestion from NASA API #143

Open
wants to merge 1 commit into
base: development
Choose a base branch
from

Conversation

GiusGasSmart
Copy link
Collaborator

-Swagger API:
We have developed the Swagger API documentation for the Surface URLs.
The development work primarily involved adding the extend_schema decorator from the drf_spectacular library to each of the involved views. This allowed us to include a brief description of the API's purpose, the various parameters used, and, in some cases, the allowed responses for each endpoint.

-Data Ingestion from NASA API:
We have developed a new decoder for JSON files provided by NASA's Power Data APIs, similar in functionality to the existing ones. This required adding a new line in both the Format and Decoder tables with the name “JSON_NASA.” Additionally, we have enabled SURFACE to make API requests to external sources like NASA Power Data, allowing periodic data retrieval and storage without an FTP server. These features use existing models, a new “cron_scheduler” field in the Station table was added to schedule data retrieval tasks

Copy link

cla-bot bot commented May 10, 2024

We require contributors to sign our Contributor License Agreement, and we don't have @GiusGasSmart on file. In order for us to review and merge your code, please contact @isedwards to get yourself added.

@isedwards
Copy link
Member

@scottylad501 - I've had a quick look through this PR and it seems quite reasonable and safe. It is mostly new additions rather than changes to existing capabilities. Many of the routes in api/wx/urls.py have been moved to api/wx/urls_dir/api_urls.py as part of the API updates and I've not tested/checked that everything is still working.

Overall, the addition of OpenAPI capabilities on top of Django Rest Framework is very valuable.

How do you want to proceed?

@isedwards
Copy link
Member

@cla-bot check

@cla-bot cla-bot bot added the cla-signed label May 13, 2024
Copy link

cla-bot bot commented May 13, 2024

The cla-bot has been summoned, and re-checked this pull request!

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

Successfully merging this pull request may close these issues.

2 participants