create swagger or .proto definition api

[northdpole]

Issue

What is the issue?

as opencre.org is getting adoption we receive an increasing number of requests for SDKs, Clients or other API integrations. We currently do not have any way of integrating OpenCRE with the outside world other than its undocumented API or the frontend. If we document our API we will be able to use Open APIs code generation capabilities to create clients.

Expected Behaviour

There is a formal definition of our api in either .proto or swagger files. These files can be used to generate clients.

[iagoscm]

Hey, is this issue still in need of help?

[northdpole]

Hey, yes absolutely this is very much needed!

[iagoscm]

Nice! So I'm new on this project and with security overall, I'm an undergraduate software engineering student, and I'm on a subject that motivates us to collaborate on public repos, and I will be looking up to collaborate on this one. For now, I will set up the environment and study the project! Any tips or guidance you could give to me? @northdpole

[northdpole]

Tips: it's a project I made on my free time, you may find several snags Get on owasp.slack.com and join the #project-cre channel so we can answer questions faster 🙂

On Wed, 3 Jul 2024, 12:26 Iago Campelo, @.***> wrote:

Nice! So I'm new on this project and with security overall, I'm an undergraduate software engineering student, and I'm on a subject that motivates us to collaborate on public repos, and I will be looking up to collaborate on this one. For now, I will set up the environment and study the project! Any tips or guidance you could give to me? @northdpole https://github.com/northdpole

— Reply to this email directly, view it on GitHub https://github.com/OWASP/OpenCRE/issues/295#issuecomment-2205853142, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAMCRHSYGFGOELJZ3GXTAO3ZKPNXFAVCNFSM6AAAAABKIGVI62VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMBVHA2TGMJUGI . You are receiving this because you were mentioned.Message ID: @.***>