feat: add guardian proto

[rahmatrhd]

No description provided.

[ravisuhag]

Can we start using OpenAPI v3?

[rahmatrhd]

grpc-ecosystem/grpc-gateway#2147 the support for v3 still under development

[ravisuhag]

LGTM. @kushsharma Can you also cross-check for any conventions we are following in proton?

[kushsharma]

I see we are using int ids everywhere, are these DB auto-increment ids? Why not use UUID?

[rahmatrhd]

Yes DB auto-increment, no specific reason why we're not using UUID, just following traditional ways for creating entity. What would make it better to use UUID?

[kushsharma]

• can't enumerate values
• can't infer how many values are present in each table
• don't have to talk to the database to construct a value, useful in certain ORM situations
• perfectly indexable by most dbs
• easier to shard when we need to distribute data into multiple dbs
• unique across multiple tables/databases/space-time continuum
• costly on size but storage is cheap

[kushsharma]

@ravisuhag are we not versioning our REST APIs? Not versioning protobufs is fine I think as they get imported and get versioned while importing but REST APIs have no convention of knowing if something has breaking changes right?

[ravisuhag]

+1 to versioning. Shall we right away start with v1 as folder as well and move protos to that? or any other better idea?

[rahmatrhd]

agree on adding v1 as folder inside existing api folder as well.

should we add the prefix /api as well in the url? => /api/v1/resources... currently we don't

[ravisuhag]

let's skip /api if needed service should handle it.

[kushsharma]

Yeah, we can version protobufs at directory/package level as well although once we have stable services, function definition hardly changes, only message fields do and that can be handled by only introducing new fields with new indices and supporting old fields as well. But yeah I am onboard with directory level versioning as well.
I need to refactor optimus protobufs though, went with the simplest one when started and now it has so many things going on.
Like this

.
└── proto
    └── foo
        └── bar
            ├── bat
            │   └── v1
            │       └── bat.proto // package foo.bar.bat.v1
            └── baz
                └── v1
                    ├── baz.proto         // package foo.bar.baz.v1
                    └── baz_service.proto // package foo.bar.baz.v1

[ravisuhag]

@rahmatrhd lets make the discussed changes and then we can merge.

[ravisuhag]

@rahmatrhd @kushsharma Are we moving protos to V1 folder?

[rohilsurana]

package odpf.guardian; => package odpf.guardian.v1;
option go_package = "github.com/odpf/proton/guardian"; => option go_package = "github.com/odpf/proton/guardian/v1;guardianv1";

same goes for the directory as well.

[rohilsurana]

Let's follow semver for openapiv2_swagger.info.version.