This is an automated email from the ASF dual-hosted git repository. machristie pushed a commit to branch custos-integration in repository https://gitbox.apache.org/repos/asf/airavata-data-catalog.git
commit fdebc4fcdf86d84a52badd043a1eeb244f9083b2 Author: Marcus Christie <[email protected]> AuthorDate: Tue Jan 31 17:45:59 2023 -0500 Adding API documentation --- .../airavata/datacatalog/api/model/UserEntity.java | 4 ++++ .../stubs/src/main/proto/DataCatalogAPI.proto | 18 ++++++++++++++++++ 2 files changed, 22 insertions(+) diff --git a/data-catalog-api/server/src/main/java/org/apache/airavata/datacatalog/api/model/UserEntity.java b/data-catalog-api/server/src/main/java/org/apache/airavata/datacatalog/api/model/UserEntity.java index 0540ab2..99a642a 100644 --- a/data-catalog-api/server/src/main/java/org/apache/airavata/datacatalog/api/model/UserEntity.java +++ b/data-catalog-api/server/src/main/java/org/apache/airavata/datacatalog/api/model/UserEntity.java @@ -19,6 +19,10 @@ public class UserEntity { @Column(name = "user_id") private Long userId; + /** + * The identifier for the user. This external identifier comes from the user + * management service that data catalog is configured to use. + */ @Basic @Column(name = "external_id", nullable = false) private String externalId; diff --git a/data-catalog-api/stubs/src/main/proto/DataCatalogAPI.proto b/data-catalog-api/stubs/src/main/proto/DataCatalogAPI.proto index bc8f656..9508fff 100644 --- a/data-catalog-api/stubs/src/main/proto/DataCatalogAPI.proto +++ b/data-catalog-api/stubs/src/main/proto/DataCatalogAPI.proto @@ -21,12 +21,30 @@ option java_multiple_files = true; option java_package = "org.apache.airavata.datacatalog.api"; message UserInfo { + /* + * This is an external identifier for the user, which identifies the user in + * whatever user management scheme data catalog is integrated with. + */ string user_id = 1; + /* + * This is an (optional) external identifier for the tenant, which + * identifies the tenant in whatever tenant management scheme data catalog + * is integrated with. + */ optional string tenant_id = 2; } message GroupInfo { + /* + * This is an external identifier for the group, which identifies the group in + * whatever group management scheme data catalog is integrated with. + */ string group_id = 1; + /* + * This is an (optional) external identifier for the tenant, which + * identifies the tenant in whatever tenant management scheme data catalog + * is integrated with. + */ optional string tenant_id = 2; }
