Skip to content

openrpc based api #2371

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
Closed
wants to merge 3 commits into from
Closed

openrpc based api #2371

wants to merge 3 commits into from

Conversation

Omarabdul3ziz
Copy link
Contributor

@Omarabdul3ziz Omarabdul3ziz commented Jul 2, 2024 •
edited
Loading

Pr contains

  • openrpc spec file that represents all zos endpoints and their types.
  • a simple tool that generates go code based on this specs
  • a service that runs jsonrpc protocol serving all zos endpoints using net/rpc package

Internal modifications:

  • seperate the perf task getters to have a method for each task with a
    defined result type instead of interface{}
  • modify healthcheck task to have its result as slice of object
    containes the check name instead of map from name to error
  • modify public ip task to have its result as slice of reports with the
    ip included instead of map from the ip to report
  • update performance monitor stub
  • modify the diagnositcs response to be slice of modules status instead
    of map

Related issues

@Omarabdul3ziz
implement openrpc-codegen tool:
38a0b91 
- create openrpc.json spec file that represent all zos types and api
  handlers
- create a tool that generate go types/methods from the spec file with
  the limitation for the `net/rpc` package services
@Omarabdul3ziz
internal code modifications to be compatible with openrpc spec:
8b64fae 
- seperate the perf task getters to have a method for each task with a
  defined result type instead of interface{}
- modify healthcheck task to have its result as slice of object
  containes the check name instead of map from name to error
- modify public ip task to have its result as slice of reports with the
  ip included instead of map from the ip to report
- update performance monitor stub
- modify the diagnositcs response to be slice of modules status instead
  of map
@Omarabdul3ziz
implement a jsonrpc api for all zos endpoint followin net/rpc pkg
7c12991 
protocol.
@Omarabdul3ziz Omarabdul3ziz changed the title wip: openrpc based api openrpc based api Jul 17, 2024
@Omarabdul3ziz
Copy link
Contributor Author

close for threefoldtech/zosbase#26

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

Reviewers

@muhamadazmy muhamadazmy Awaiting requested review from muhamadazmy muhamadazmy will be requested when the pull request is marked ready for review muhamadazmy is a code owner

@ashraffouda ashraffouda Awaiting requested review from ashraffouda ashraffouda will be requested when the pull request is marked ready for review ashraffouda is a code owner

@rawdaGastan rawdaGastan Awaiting requested review from rawdaGastan rawdaGastan will be requested when the pull request is marked ready for review rawdaGastan is a code owner

@xmonader xmonader Awaiting requested review from xmonader xmonader will be requested when the pull request is marked ready for review xmonader is a code owner

@Eslam-Nawara Eslam-Nawara Awaiting requested review from Eslam-Nawara Eslam-Nawara will be requested when the pull request is marked ready for review Eslam-Nawara is a code owner

@AhmedHanafy725 AhmedHanafy725 Awaiting requested review from AhmedHanafy725 AhmedHanafy725 will be requested when the pull request is marked ready for review AhmedHanafy725 is a code owner

@sameh-farouk sameh-farouk Awaiting requested review from sameh-farouk sameh-farouk will be requested when the pull request is marked ready for review sameh-farouk is a code owner

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Omarabdul3ziz