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

README onboarding-sdk #29

Merged
merged 2 commits into from
Oct 30, 2023
Merged

README onboarding-sdk #29

merged 2 commits into from
Oct 30, 2023

Conversation

manuraf
Copy link
Contributor

@manuraf manuraf commented Oct 26, 2023

List of Changes

Added REAME to onboarding parent
Added REAME to onboarding sdk

Motivation and Context

Update documentation about onboarding-sdk

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

  • My change requires a change to the documentation.
  • I have updated the documentation accordingly.

@manuraf manuraf requested a review from a team as a code owner October 26, 2023 13:25
@manuraf manuraf changed the title added readme for sdk README onboarding-sdk Oct 26, 2023
@manuraf manuraf merged commit f0f4464 into develop Oct 30, 2023
3 checks passed
@manuraf manuraf deleted the docs/readme-sdk branch October 30, 2023 11:50
@@ -0,0 +1,154 @@
# Onboarding SDK Product

This library has been developed to provide a set of Java utility classes to simplify the work of handle **Selfcare Product** as string.
Copy link
Contributor

Choose a reason for hiding this comment

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

when do we have such a need?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Selfcare Products is a collection of PagoPA products available for use by institutions. Each product contains specific information, such as its status, admitted role, or a filepath template for building contract necessary for selfcare business logic.

Currently, these product records are stored in a MongoDB collection which are accessible through a REST API.
We are planning to replace this architecture with a file-based approach in our roadmap. This change is driven by the fact that all product information requires only 36KB of storage so we will saving in terms of resource and maintenance.

The Onboarding SDK Product offers a set of classes designed for managing this collection of records using a file.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants