Add standardized REST interface to Hamsta
a project by pkacer
Updated about 2 years ago. No love.

Hamsta currently lacks a standardized network interface that would allow other systems accessing its capabilities. There is a custom network interface with text-parsing based protocol that is poorly documented and needs to be implemented on the client side to be usable. This interface does not use any standardized way of communication or library.

This project suggests to add a standardized web service interface (let us call it API) to Hamsta. Expected attributes are following.

  • Standardized interface (i.e. described and known outside of our department).
  • Uses tested library.
  • Usable by any type of frontend (web, command line, desktop or smartphone application, ...).
  • Usable by any type of interfacing system.

The project is divided into several steps.

  1. Select interface protocol.
  2. Select (backend) implementation library.
  3. Define available interface functions.
  4. Add library integration.
  5. Implement interface functions and do testing.
  6. Document the interface.

Ideas for the interface protocol are following.

  • XML-RPC
  • JSON-RPC
  • SOAP

The idea of adding the interface is old. Part of this project idea comes from FATE #315109. But generally this project is to support needed architectural changes in Hamsta.

Pavel Kacer (pkacer@suse.com) is responsible for this project. The stakeholders are QA Automation team members and project manager.

There is no code. All decisions and implementation have to be made, yet.

Join this project

Looking for hackers with the skills:

hamsta rest perl xmlrpc

This project is part of:

Hack Week 10

Activity

  • over 8 years ago: tboerger disliked this project.
  • over 9 years ago: pkacer removed keyword interface from this project.
  • over 9 years ago: pkacer added keyword "xmlrpc" to this project.
  • over 9 years ago: pkacer added keyword "perl" to this project.
  • over 9 years ago: tboerger liked this project.
  • over 9 years ago: pkacer added keyword "hamsta" to this project.
  • over 9 years ago: pkacer added keyword "rest" to this project.
  • over 9 years ago: pkacer added keyword "interface" to this project.
  • over 9 years ago: pkacer started this project.
  • over 9 years ago: pkacer originated this project.


    • Comments

    • pkacer
      over 9 years ago by pkacer | Reply

      Because of the other project (fix Hamsta OpenID) I got to this one only yesterday late afternoon.

      I am studying different XML-RPC implementations in Perl to evaluate which one would be best for us.

    Similar Projects

    Proof of Concept for a Perl binding to libfyaml by tinita

    Project Description

    Similar to [YAML::Lib...

    Run autoupdate-perl in CI by tinita

    Project Description

    Currently [autpupdate...

    Port the Minion job queue to TypeScript by kraih

    Project Description

    As part of the [mojo....

    Implement text based OCR in openQA by clanig

    Project Description

    Currently openQA requir...

    OSSelot collaboration on legal reviews of community packages by lkocman

    [comment]: # (Please use the project descriptio...