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.

Sign up for GitHub

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

Jump to bottom

Meaningful Documentation End-point for Micro-services #1885

Closed
27 tasks done
mdebarros opened this issue Nov 30, 2020 · 0 comments
Closed
27 tasks done

Meaningful Documentation End-point for Micro-services #1885

mdebarros opened this issue Nov 30, 2020 · 0 comments
Assignees
@oderayi
Labels
oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it story
Milestone
Sprint 12.3

Comments

@mdebarros
Copy link
Member

mdebarros commented Nov 30, 2020 •
edited by oderayi
Loading

Goal:

As a Developer

I want access to meaningful-documented API end-points that are generated from the swagger for each micro-service

so that the documentation information is populated directly from the swagger (and not code).

Acceptance Criteria:

  • /documentation end-point provides meaningful API documentation based on the micro-service interface swagger specification
  • /swagger.json is available, and is provided by the interface specification (not generated from code)
  • Services
    • Account-lookup
    • Quoting-Service
    • Central-Ledger (Admin API)
    • Central-Settlements
    • ML-API-Adapter

Complexity: <High|Medium|Low> > A short comment to remind the reason for the rating

Uncertainty: <High|Medium|Low> > A short comment to remind the reason for the rating

Tasks:

  • Investigate alternatives to hapi-swagger (Shins, Widdershins, ReDoc, ReSlate) [@oderayi ]
  • Present results to team and select best alternative [@oderayi]
  • Implement adopted libraries (Widdershins, Shins) as Hapi plugin in Central Services Shared [@oderayi]
  • Implement plugin in the following services:

Done

  • Acceptance Criteria pass
  • Designs are up-to date
  • Unit Tests pass
  • Integration Tests pass
  • Code Style & Coverage meets standards
  • Changes made to config (default.json) are broadcast to team and follow-up tasks added to update helm charts and other deployment config.

Pull Requests:

Follow-up:

  • N/A

Dependencies:

  • N/A

Accountability:

  • Owner: TBC
  • QA/Review: TBC
@mdebarros mdebarros added story to-be-refined This story is ready to be groomed labels Nov 30, 2020
@oderayi oderayi added the oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it label Dec 1, 2020
@oderayi oderayi self-assigned this Dec 1, 2020
@oderayi oderayi added this to the Sprint 12.3 milestone Dec 1, 2020
@elnyry-sam-k elnyry-sam-k removed the to-be-refined This story is ready to be groomed label Dec 4, 2020
@oderayi oderayi closed this as completed Dec 14, 2020
mdebarros pushed a commit to mdebarros/project that referenced this issue May 12, 2021
@oderayi
mojaloop#1885: Update API documenation (mojaloop#379)
0cf0508 
* Update API documenattion

* Restore default configs

* Fix integration test.

* Fix audit

* Fix integration test config
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@oderayi oderayi

Labels
oss-core This is an issue - story or epic related to a feature on a Mojaloop core service or related to it story
Projects
None yet
Milestone
Sprint 12.3
Development

No branches or pull requests
3 participants
@oderayi @elnyry-sam-k @mdebarros