Sharing a new wiki page that analyzes the service API endpoints for reporting ingestion

[Craig Appl]

Hi Everyone,

I just finished a research spike for OLMIS-4651 that includes an analysis of all service API endpoints identifying how frequently the information changes and recommending whether we should consider ingesting it in the reporting stack. This is our first step in understanding what information should be stored in the reporting platform and assessing appropriate data models. 

This assessment also includes notes. Please review the notes in red for issues that may require development to improve the API. https://openlmis.atlassian.net/wiki/spaces/OP/pages/374636847/Microservice+API+Analysis+for+Reporting

Sincerely,

Craig

[Łukasz Lewczyński]

Hi Craig,

I reviewed endpoints with red notes and proposed some actions in the https://openlmis.atlassian.net/wiki/spaces/OP/pages/380305418/APIs+Tech+Debt+review I hope we can discuss this on the next tech committee meeting.

Regards,

Lukasz

Łukasz Lewczyński
Software Developer
llewc...@soldevelo.com

--
You received this message because you are subscribed to the Google Groups "OpenLMIS Dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev+unsubscribe@googlegroups.com.
To post to this group, send email to openlm...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/f220702e-b63d-4f87-b7f2-ea45b21632ed%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

SolDevelo Sp. z o.o. [LLC] / www.soldevelo.com
Al. Zwycięstwa 96/98, 81-451, Gdynia, Poland
Phone: +48 58 782 45 40 / Fax: +48 58 782 45 41

[Łukasz Lewczyński]

Hi all,

We are few days after Technical Committee meeting and I still don't see any comments so I assume that we agree to:

1. Create a new endpoint to retrieve a single commodity type by id
   
2. Remove facilities/supplying endpoint because it is not used by any service
   
3. Update lots endpoint by removing information that those endpoints are experimental and adding missing JSON schema
   
4. Merge the following endpoints:
   
• orderableDisplayCategories and orderableDisplayCategories/search
  
• processingSchedules and processingSchedules/search
  
• programs and programs/search
  
• requisitionGroups and requisitionGroups/search
  
• rights and rights/search
  
• supplyLines and supplyLines/searchByUUID
  
• requisitions and requisitions/search
  
5. Rename parameters in roles and user endpoints. For example for roles endpoint we use roleId instead id
6. Add description to tradeItems/{id} endpoint

If you disagree please let me know by replying to this email or by leaving comment on the wiki page

Regards,

Lukasz

Łukasz Lewczyński
Software Developer
llewc...@soldevelo.com

On Thu, May 17, 2018 at 11:39 AM Łukasz Lewczyński <llewc...@soldevelo.com> wrote:

Hi Craig,

I reviewed endpoints with red notes and proposed some actions in the https://openlmis.atlassian.net/wiki/spaces/OP/pages/380305418/APIs+Tech+Debt+review I hope we can discuss this on the next tech committee meeting.

Regards,

Lukasz

Łukasz Lewczyński
Software Developer
llewc...@soldevelo.com

On Wed, May 9, 2018 at 2:50 PM, Craig Appl <ca...@ona.io> wrote:

Hi Everyone,

I just finished a research spike for OLMIS-4651 that includes an analysis of all service API endpoints identifying how frequently the information changes and recommending whether we should consider ingesting it in the reporting stack. This is our first step in understanding what information should be stored in the reporting platform and assessing appropriate data models. 

This assessment also includes notes. Please review the notes in red for issues that may require development to improve the API. https://openlmis.atlassian.net/wiki/spaces/OP/pages/374636847/Microservice+API+Analysis+for+Reporting

Sincerely,

Craig

--
You received this message because you are subscribed to the Google Groups "OpenLMIS Dev" group.

To unsubscribe from this group and stop receiving emails from it, send an email to openlmis-dev...@googlegroups.com.

To post to this group, send email to openlm...@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/openlmis-dev/f220702e-b63d-4f87-b7f2-ea45b21632ed%40googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Łukasz Lewczyński]

Hi all again,

As I said on the last Technical Committee meeting I created tickets for points mentioned in the previous mail. Links to tickets have been added to the wiki page and also they can be easly find because all of them have the APITechDebt label: link

Regards,

Lukasz

Łukasz Lewczyński
Software Developer
llewc...@soldevelo.com