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

Measurment api guide #131

Merged
merged 11 commits into from
Sep 12, 2024
Merged

Measurment api guide #131

merged 11 commits into from
Sep 12, 2024

Conversation

ketankartoza
Copy link
Contributor

This PR is for the issue #129

@ketankartoza ketankartoza added documentation Improvements or additions to documentation Size: 8 labels Sep 5, 2024
@ketankartoza ketankartoza self-assigned this Sep 5, 2024
Copy link

github-actions bot commented Sep 5, 2024

☂️ Python Coverage

current status: ✅

Overall Coverage

Lines Covered Coverage Threshold Status
7167 6772 94% 0% 🟢

New Files

No new covered files...

Modified Files

No covered modified files...

updated for commit: b4a5ced by action🐍

Copy link

codecov bot commented Sep 5, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.45%. Comparing base (5bcc168) to head (b4a5ced).
Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #131   +/-   ##
=======================================
  Coverage   94.45%   94.45%           
=======================================
  Files         123      123           
  Lines        6955     6955           
=======================================
  Hits         6569     6569           
  Misses        386      386           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@mvmaltitz mvmaltitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have made some changes to the wording. We should add the data and attribute tables.

Copy link
Contributor

@mvmaltitz mvmaltitz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks good

@ketankartoza ketankartoza marked this pull request as ready for review September 6, 2024 12:37

**Example of Python Code To Access the API**

![Python code to access API](./img/api-guide-8.png)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ketankartoza, can you use the code block instead of image here? so the user can copy paste the codes. It would also be good to have another language example like using curl.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Okay @danangmassandy I will add 2-3 examples.


**GET API:**

Click on the GET API it will show the attribute to enter to get the data. Click on the 1️⃣ `Try it out` button, to fill the detailed in the 2️⃣ available fields. After filling the details click on the 3️⃣ `Exicute` button, to run the API.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is typo on 'Exicute' button

| Observation | Air Temperature Average | | °C | average_air_temperature |
| Observation | Air Temperature Max | | °C | max_air_temperature |
| Observation | Air Temperature Min | | °C | min_air_temperature |
| **WIP** |
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

please remove the WIP and attributes under the section

@danangmassandy
Copy link
Collaborator

@ketankartoza can you also add another section called available format types?
The API can have different output types:

  • json: this type is only available for querying by single point
  • csv
  • netcdf: Only available for historical_reanalysis and seasonal_forecast.

@mvmaltitz mvmaltitz removed the Size: 8 label Sep 12, 2024
Copy link
Collaborator

@danangmassandy danangmassandy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, thanks @ketankartoza!

@danangmassandy danangmassandy merged commit 280c723 into main Sep 12, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants