...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
CAMARA Population Density Data API - Follow-up meeting #7 - 2024-05-28
May 08th, 2024
Attendees
Name | Company |
|---|---|
| Sachin Kumar | Vodafone |
| Gregory Liokumovich | Ericsson |
| Violeta Gonzalez Fernandez | Telefonica |
| Jorge Garcia | Telefonica |
Population Density Data API minutes: https://wikilf-camaraproject.camaraprojectatlassian.orgnet/wiki/display/CAM/Population+Density+Data+API+Minutes
Agenda
- Approval of previous meeting minutes #6 and meeting agenda
- Open issues and PRs
- Issues: #7 #12 #13 #14 #15 #16 #20
- PR #19 #21
- Initial algorithm proposal review
- Timeline and next steps
- AoB
Open Issues & PRs
| Issue#7 | Telefonica | Default and limit values for the API Characteristics |
| Issue#12 | Telefonica | Discussion on API algorithm - Initial proposal |
| Issue#13 | Ericsson | API time format |
| Issue#14 | Ericsson | Exposed data - Population vs density |
| Issue#15 | Ericsson | Including redoc and swagger editor link in readme |
| Issue#16 | Orange | Area format alignement |
| Issue#20 | Orange | Async operation proposal |
| PR#19 | Telefonica | Modification of readme |
| PR#21 | Telefonica | Solves #6 #7 #10 #13 #15 #20 (open) |
Approval of previous meeting minutes & documentation (1)
→ → Approved
API proposal review (2)
Different discussions raised during the API review:
Issue#7 Open discussion on default and limit values for the API characteristics:
Issue to be closed after "bigger area than supported" error is included in the code (solved)Closed
Ericsson: Time format alignment with commonalities, supporting RFC instead of ISO
Issue to be closed after RFC format is included in the code (solved)Issue Closed
Ericsson: Response content should follow the expected as in the API name, it is, density instead of population count
...
AP: to define what max and min means in the calculated forecast. Also reconsider average as a forecast response, maybe just "expected"/"forecasted" population value
to be closed, including proper density value (people/km2). To continue in #23 and discussion for the definitions of the parameters.
Ericsson: adding redoc and swagger editor links in API readme.
TEF: Mainly used in stable versions when a release is launched, in any case it's proposed in PR#19
Issue to be closed after swagger editors links are added to readme (solved)Issue Closed and PR merged
Orange: Align location area format with other APIs of CAMARA
Issue to be closed after location format is included in the code (solved)Issue Closed
Orange: Proposal and alternative for implementation of async mechanism in the API response
Discussion: 2 proposals of resolution:
- Callback URL/ weebhookwebhook: More complex approach for the developer, but more suitable for unexpected response delays.
- To include also a failure response for the callback in case the process cannot be completed. → done
- Also to be included an error for the sync response → done
- GET endpoint and requestID: easier to implement, more suitable for fast response APIs or APIs which response is expected in a specific delay. In longer responses, developer should poll the get endpoint.
- Callback URL/ weebhookwebhook: More complex approach for the developer, but more suitable for unexpected response delays.
Discussion: Not clear about best option. Current one, specified in #21, is focused on callback mechanism. To be confirmed offline
AP: Confirm strategy on the proposal to first focus on current callback mechanism for this version, adapted to any modification of Commonalities Subscription mechanism.
Solving Issue#15
PR to be mergedclosed
Solves #6 #7 #10 #13 & #15. #20 still open about details, also to be aligned with async/subscription mechanism in commoonalitiescommonalities
PR to To be reviewed and merged when closing Issue#20
Initial algorithm proposal (3)
Population Density API - Algorithm.pdf
→ To provide feedback
Question: how to proceed?
PR to be opened for further discussion on documentation.
AoB (4)
Authentication/security discussion opened around the usage of 2-3 legged access tokens for this API(s). Discussion to be opened in #24
Discussion Summary
| Issue#7 | Default and limit values for the API Characteristics |
| Closed | ||
| Issue#12 | Discussion on API algorithm | Follow discussion in Github, once PR open |
| Issue#13 | API time format |
| Closed | |
| Issue#14 | Exposed data - Population vs density |
| Agreed to include people/km2 as format, definition discussion to be treated in #23 | |
| Issue#15 | Including redoc and swagger editor link in readme |
| Closed | |
| Issue#16 | Area format alignment |
| Closed | |
| PR#19 | Modification of readme |
| Merged | ||
| Issue#20 | Async operation proposal | First option proposed in PR#21, still to discuss offline |
| PR#21 | Solves #6 #7 #10 #13 #15 #20 (open) | To be reviewed and merged |
| Issue#23 |
| Response parameters definitions | (NEW) to be treated offline | |
| AoB | Discussion on authentication management | (NEW) to be treated offline → Issue#24 |
Next steps
- Feedback on algorithm proposal→ Follow-up meeting #7#8
- Close async mechanism #7#8
- Parameter definitions #8
- RC API spec agreement → Follow-up meeting #7#8
- Next call will be May 22th, 2024