zitadel/site/docs/develop/00-overview.en.md
Max Peintner 22d4c345be
docs: image gallery viewer (#905)
* add assets, photoswipe html element to body

* add single script, gallery for multiple items

* update docs for image gallery

* fix relative links

* inject image script on mount

* replace inline script

* remove facebook, twitter, pinterest sharing

* fix hover on share

* fix start img aspect radio, reduce size

* right align json script

* right align go script

* change script background
2020-10-26 13:03:51 +01:00

1.6 KiB

title description
Overview

All documentations are under active work and subject to change soon!

APIs


ZITADEL provides three API's for different use cases. These API's are built with GRPC and then generate a REST service. Each services proto definition is located in the source control on GitHub. As we generate the REST services and Swagger file out of the proto definition we recommend that you rely on the proto file. We annotate the corresponding REST methods on each possible call as well as the AuthN and AuthZ requirements.

See below for an example with the call GetMyUser.

  //User
  rpc GetMyUser(google.protobuf.Empty) returns (UserView) {
    option (google.api.http) = {
      get: "/users/me"
    };

    option (caos.zitadel.utils.v1.auth_option) = {
      permission: "authenticated"
    };
  }

As you can see the GetMyUser function is also available as REST service under the path /users/me. In the table below you can see the URI of those calls.

Service URI
REST https://api.zitadel.ch/auth/v1/users/me
GRPC https://api.zitadel.ch/caos.zitadel.auth.api.v1.AuthService/GetMyUser