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

[API] Endpoint: Territories #304

Open
JFQueralt opened this issue Feb 18, 2021 · 0 comments
Open

[API] Endpoint: Territories #304

JFQueralt opened this issue Feb 18, 2021 · 0 comments
Labels
Module: API Issues related to the API. ⌨ Need: Code This Issue involves some sort of coding. ⚡ Priority: High This task has High priority. Project: PLD Issue related to Project Lockdown. ✔ Stage: Ready This Task is ready to be implemented. ⌨ Team: Devs Task related to Team Developers.

Comments

@JFQueralt
Copy link
Member

JFQueralt commented Feb 18, 2021

logo

Objectives

For full context on this issue, check its related Epic #64

💯 Proposed solution

Implement an API that will provide with the following services as described below.

💠 Endpoint documentation

https://theiofoundation.stoplight.io/docs/projectlockdown/API/Reference/Project-Lockdown.v1.json/paths/~1Territories~1%7BPLDCode%7D~1%7BDepth%7D/get

✔ Definition of Done

  • api endpoint as per documentation is available to GET territory data
  • deployed to production server
  • requests are cached to limit impact on servers/database
  • response is provided in json format, but has option to add other formats in the future
  • basic unit tests on the code

Resources

📖 Technical documentation

  • API reference (includes mock server): Stoplight
  • JSON Models reference (schemas): Stoplight
@JFQueralt JFQueralt added Module: API Issues related to the API. Project: PLD Issue related to Project Lockdown. ⌨ Need: Code This Issue involves some sort of coding. ⌨ Team: Devs Task related to Team Developers. 💧 Priority: Medium This task has Medium priority. 📑 Team: Docs Task related to Team Documentation. 🚧 Stage: Not Ready This Task is not yet ready and its description needs to be finalized. labels Feb 18, 2021
@JFQueralt JFQueralt mentioned this issue Feb 18, 2021
24 tasks
@jeff-knurek jeff-knurek added ✔ Stage: Ready This Task is ready to be implemented. ⚡ Priority: High This task has High priority. and removed 🚧 Stage: Not Ready This Task is not yet ready and its description needs to be finalized. 📑 Team: Docs Task related to Team Documentation. 💧 Priority: Medium This task has Medium priority. labels Feb 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Module: API Issues related to the API. ⌨ Need: Code This Issue involves some sort of coding. ⚡ Priority: High This task has High priority. Project: PLD Issue related to Project Lockdown. ✔ Stage: Ready This Task is ready to be implemented. ⌨ Team: Devs Task related to Team Developers.
Development

No branches or pull requests

2 participants