-
Notifications
You must be signed in to change notification settings - Fork 0
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
Measurment api guide #131
Conversation
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified FilesNo covered modified files...
|
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
There was a problem hiding this 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.
12202d3
to
58e282b
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks good
|
||
**Example of Python Code To Access the API** | ||
|
||
![Python code to access API](./img/api-guide-8.png) |
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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. |
There was a problem hiding this comment.
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** | |
There was a problem hiding this comment.
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
@ketankartoza can you also add another section called available format types?
|
Changed title
Changed Title
Changed TomorrowNow API to OSIRIS II API
abc5a7a
to
b4a5ced
Compare
There was a problem hiding this 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!
This PR is for the issue #129