From df1a207a1292c82c872210311beb609c77e2cf9a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Juan=20Pablo=20Villaf=C3=A1=C3=B1ez?= Date: Thu, 20 Jan 2022 11:58:41 +0100 Subject: [PATCH] Adjust formatting and fix links --- protogen/docs/GRPC.tmpl | 22 +++++++++---------- .../ocis/messages/accounts/v1/accounts.pb.go | 20 ++++++++--------- .../accounts/v1/accounts.swagger.json | 18 +++++++-------- .../ocis/messages/accounts/v1/accounts.proto | 22 ++++++++++--------- 4 files changed, 41 insertions(+), 41 deletions(-) diff --git a/protogen/docs/GRPC.tmpl b/protogen/docs/GRPC.tmpl index e96761c8c8..5940398adb 100644 --- a/protogen/docs/GRPC.tmpl +++ b/protogen/docs/GRPC.tmpl @@ -32,14 +32,14 @@ geekdocFilePath: grpc.md {{- $ltypePkg := slice $ltypeSpl 0 (sub (len $ltypeSpl) 1) | join "." -}} {{- $loca = printf "/grpc_apis/%s/#%s" $ltypePkg (.Type | lower) -}} {{- end -}} -| {{.Name}} | [{{.LongType}}]({{ $loca }}) | {{.Label}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | +| {{.Name}} | [{{.LongType}}]({{ $loca }}) | {{.Label}} | {{ .Description | replace "\n" "
" }}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end }} | {{ end -}} {{ end }} {{ if .HasExtensions -}} | Extension | Type | Base | Number | Description | | --------- | ---- | ---- | ------ | ----------- | {{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | +| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{ .Description | replace "\n" "
" }}{{if .DefaultValue}} Default: {{.DefaultValue}}{{end}} | {{ end -}} {{ end -}} {{ end -}} @@ -51,7 +51,7 @@ geekdocFilePath: grpc.md | Name | Number | Description | | ---- | ------ | ----------- | {{range .Values -}} -| {{.Name}} | {{.Number}} | {{nobr .Description}} | +| {{.Name}} | {{.Number}} | {{ .Description | replace "\n" "
" }} | {{ end -}} {{ end -}} @@ -61,7 +61,7 @@ geekdocFilePath: grpc.md | Extension | Type | Base | Number | Description | | --------- | ---- | ---- | ------ | ----------- | {{ range .Extensions -}} -| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{nobr .Description}}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | +| {{.Name}} | {{.LongType}} | {{.ContainingLongType}} | {{.Number}} | {{ .Description | replace "\n" "
" }}{{if .DefaultValue}} Default: `{{.DefaultValue}}`{{end}} | {{ end -}} {{ end -}} {{- range .Services }} @@ -75,16 +75,16 @@ geekdocFilePath: grpc.md {{- $reqLoca := printf "#%s" (.RequestLongType | lower | replace "." "") -}} {{- $respLoca := printf "#%s" (.ResponseLongType | lower | replace "." "") -}} {{- if and (hasPrefix ".ocis." .RequestLongType) (ge (len $filenameParts) 3) }} - {{- $rep := regexReplaceAll "[^/]+" (slice $filenameParts 1 (sub (len $filenameParts) 1) | join "/") ".." -}} - {{- $reqDir := dir (.RequestLongType | lower | replace "." "/") -}} - {{- $reqLoca = printf "%s/%s/grpc.md#%s" $rep (substr 6 (len $reqDir) $reqDir) (.RequestType | lower | replace "." "") -}} + {{- $ltypeSpl := .RequestLongType | substr 1 -1 | splitList "." -}} + {{- $ltypePkg := slice $ltypeSpl 0 (sub (len $ltypeSpl) 1) | join "." -}} + {{- $reqLoca = printf "/grpc_apis/%s/#%s" $ltypePkg (.RequestType | lower) -}} {{- end -}} {{- if and (hasPrefix ".ocis." .ResponseLongType) (ge (len $filenameParts) 3) }} - {{- $rep := regexReplaceAll "[^/]+" (slice $filenameParts 1 (sub (len $filenameParts) 1) | join "/") ".." -}} - {{- $respDir := dir (.ResponseLongType | lower | replace "." "/") -}} - {{- $respLoca = printf "%s/%s/grpc.md#%s" $rep (substr 6 (len $respDir) $respDir) (.ResponseType | lower | replace "." "") -}} + {{- $ltypeSpl := .ResponseLongType | substr 1 -1 | splitList "." -}} + {{- $ltypePkg := slice $ltypeSpl 0 (sub (len $ltypeSpl) 1) | join "." -}} + {{- $respLoca = printf "/grpc_apis/%s/#%s" $ltypePkg (.ResponseType | lower) -}} {{- end -}} -| {{.Name}} | [{{.RequestLongType}}]({{ $reqLoca }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}]({{ $respLoca }}){{if .ResponseStreaming}} stream{{end}} | {{nobr .Description}} | +| {{.Name}} | [{{.RequestLongType}}]({{ $reqLoca }}){{if .RequestStreaming}} stream{{end}} | [{{.ResponseLongType}}]({{ $respLoca }}){{if .ResponseStreaming}} stream{{end}} | {{ .Description | replace "\n" "
" }} | {{ end -}} {{ end -}} {{ end }} diff --git a/protogen/gen/ocis/messages/accounts/v1/accounts.pb.go b/protogen/gen/ocis/messages/accounts/v1/accounts.pb.go index d55cb8b773..ac50fa2e97 100644 --- a/protogen/gen/ocis/messages/accounts/v1/accounts.pb.go +++ b/protogen/gen/ocis/messages/accounts/v1/accounts.pb.go @@ -30,13 +30,13 @@ type Account struct { // The unique identifier for the user. Key. Not nullable. Non reassignable. Read-only. Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` - // *true* if the account is enabled; otherwise, *false*. This property is required when a user is created. Supports $filter. + // `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Supports $filter. AccountEnabled bool `protobuf:"varint,2,opt,name=account_enabled,json=accountEnabled,proto3" json:"account_enabled,omitempty"` // A resource account is also known as a /disabled user object/ in Azure AD, and can be used to represent resources in general. // In Exchange it might be used to represent conference rooms, for example, and allow them to have a phone number. // You could give printers or machines with a sync client resource accounts as well. // A resource account can be homed in Microsoft 365 or on premises using Skype for Business Server 2019. - // *true* if the user is a resource account; otherwise, *false*. Null value should be considered false. + // `true` if the user is a resource account; otherwise, `false`. Null value should be considered false. IsResourceAccount bool `protobuf:"varint,3,opt,name=is_resource_account,json=isResourceAccount,proto3" json:"is_resource_account,omitempty"` // Indicates whether the account was created as // - a regular school or work account ("" / emptystring), @@ -57,7 +57,6 @@ type Account struct { // The username // posixaccount MUST uid PreferredName string `protobuf:"bytes,7,opt,name=preferred_name,json=preferredName,proto3" json:"preferred_name,omitempty"` - // TODO rename to on_premise_? or move to extension? see https://docs.microsoft.com/en-us/graph/extensibility-open-users // used for exposing the user using ldap // posixaccount MUST uidnumber UidNumber int64 `protobuf:"varint,8,opt,name=uid_number,json=uidNumber,proto3" json:"uid_number,omitempty"` @@ -83,8 +82,8 @@ type Account struct { CreatedDateTime *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=created_date_time,json=createdDateTime,proto3" json:"created_date_time,omitempty"` // The date and time the user was deleted. Returned only on $select. DeletedDateTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=deleted_date_time,json=deletedDateTime,proto3" json:"deleted_date_time,omitempty"` - // *true* if this object is synced from an on-premises directory; - // *false* if this object was originally synced from an on-premises directory but is no longer synced; + // `true` if this object is synced from an on-premises directory; + // `false` if this object was originally synced from an on-premises directory but is no longer synced; // null if this object has never been synced from an on-premises directory (default). Read-only OnPremisesSyncEnabled bool `protobuf:"varint,20,opt,name=on_premises_sync_enabled,json=onPremisesSyncEnabled,proto3" json:"on_premises_sync_enabled,omitempty"` // This property is used to associate an on-premises LDAP user to the oCIS account object. @@ -378,7 +377,7 @@ type Identities struct { Issuer string `protobuf:"bytes,2,opt,name=issuer,proto3" json:"issuer,omitempty"` // Specifies the unique identifier assigned to the user by the issuer. The combination of *issuer* and *issuerAssignedId* must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts). // When *signInType* is set to: - // * `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) *issuerAssignedId* must be a valid email address + // * `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) `issuerAssignedId` must be a valid email address // * `userName`, issuer_assigned_id must be a valid local part of an email address // Supports $filter. 512 character limit. IssuerAssignedId string `protobuf:"bytes,3,opt,name=issuer_assigned_id,json=issuerAssignedId,proto3" json:"issuer_assigned_id,omitempty"` @@ -452,9 +451,9 @@ type PasswordProfile struct { //This value is an enumeration with one possible value being “DisableStrongPassword”, which allows weaker passwords than the default policy to be specified. // “DisablePasswordExpiration” can also be specified. PasswordPolicies []string `protobuf:"bytes,3,rep,name=password_policies,json=passwordPolicies,proto3" json:"password_policies,omitempty"` - // *true* if the user must change her password on the next login; otherwise false. + // `true` if the user must change her password on the next login; otherwise false. ForceChangePasswordNextSignIn bool `protobuf:"varint,4,opt,name=force_change_password_next_sign_in,json=forceChangePasswordNextSignIn,proto3" json:"force_change_password_next_sign_in,omitempty"` - // If *true*, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + // If `true`, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. ForceChangePasswordNextSignInWithMfa bool `protobuf:"varint,5,opt,name=force_change_password_next_sign_in_with_mfa,json=forceChangePasswordNextSignInWithMfa,proto3" json:"force_change_password_next_sign_in_with_mfa,omitempty"` } @@ -538,7 +537,6 @@ type Group struct { // groupofnames MUST cn DisplayName string `protobuf:"bytes,2,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` // groupofnames MUST/MAY member // Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable. - // TODO accounts (users) only for now, we can add groups with the dedicated message using oneof construct later Members []*Account `protobuf:"bytes,3,rep,name=members,proto3" json:"members,omitempty"` // groupofnames MAY businessCategory // groupofnames MAY o @@ -568,8 +566,8 @@ type Group struct { // Visibility can be set only when a group is created; it is not editable. // Returned by default. Visibility string `protobuf:"bytes,11,opt,name=visibility,proto3" json:"visibility,omitempty"` - // *true* if this group is synced from an on-premises directory; - // *false* if this group was originally synced from an on-premises directory but is no longer synced; + // `true` if this group is synced from an on-premises directory; + // `false` if this group was originally synced from an on-premises directory but is no longer synced; // null if this object has never been synced from an on-premises directory (default). // Returned by default. Read-only. Supports $filter. OnPremisesSyncEnabled bool `protobuf:"varint,20,opt,name=on_premises_sync_enabled,json=onPremisesSyncEnabled,proto3" json:"on_premises_sync_enabled,omitempty"` diff --git a/protogen/gen/ocis/services/accounts/v1/accounts.swagger.json b/protogen/gen/ocis/services/accounts/v1/accounts.swagger.json index 37c4e9bed2..67365de3ff 100644 --- a/protogen/gen/ocis/services/accounts/v1/accounts.swagger.json +++ b/protogen/gen/ocis/services/accounts/v1/accounts.swagger.json @@ -590,11 +590,11 @@ }, "accountEnabled": { "type": "boolean", - "description": "*true* if the account is enabled; otherwise, *false*. This property is required when a user is created. Supports $filter." + "description": "`true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Supports $filter." }, "isResourceAccount": { "type": "boolean", - "description": "A resource account is also known as a /disabled user object/ in Azure AD, and can be used to represent resources in general.\nIn Exchange it might be used to represent conference rooms, for example, and allow them to have a phone number.\nYou could give printers or machines with a sync client resource accounts as well.\nA resource account can be homed in Microsoft 365 or on premises using Skype for Business Server 2019.\n*true* if the user is a resource account; otherwise, *false*. Null value should be considered false." + "description": "A resource account is also known as a /disabled user object/ in Azure AD, and can be used to represent resources in general.\nIn Exchange it might be used to represent conference rooms, for example, and allow them to have a phone number.\nYou could give printers or machines with a sync client resource accounts as well.\nA resource account can be homed in Microsoft 365 or on premises using Skype for Business Server 2019.\n`true` if the user is a resource account; otherwise, `false`. Null value should be considered false." }, "creationType": { "type": "string", @@ -618,7 +618,7 @@ "uidNumber": { "type": "string", "format": "int64", - "title": "TODO rename to on_premise_? or move to extension? see https://docs.microsoft.com/en-us/graph/extensibility-open-users\nused for exposing the user using ldap\nposixaccount MUST uidnumber" + "title": "used for exposing the user using ldap\nposixaccount MUST uidnumber" }, "gidNumber": { "type": "string", @@ -656,7 +656,7 @@ }, "onPremisesSyncEnabled": { "type": "boolean", - "title": "*true* if this object is synced from an on-premises directory;\n*false* if this object was originally synced from an on-premises directory but is no longer synced;\nnull if this object has never been synced from an on-premises directory (default). Read-only" + "title": "`true` if this object is synced from an on-premises directory;\n`false` if this object was originally synced from an on-premises directory but is no longer synced;\nnull if this object has never been synced from an on-premises directory (default). Read-only" }, "onPremisesImmutableId": { "type": "string", @@ -782,7 +782,7 @@ "items": { "$ref": "#/definitions/v1Account" }, - "title": "Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable.\nTODO accounts (users) only for now, we can add groups with the dedicated message using oneof construct later" + "description": "Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable." }, "owners": { "type": "array", @@ -825,7 +825,7 @@ }, "onPremisesSyncEnabled": { "type": "boolean", - "description": "*true* if this group is synced from an on-premises directory;\n*false* if this group was originally synced from an on-premises directory but is no longer synced;\nnull if this object has never been synced from an on-premises directory (default).\nReturned by default. Read-only. Supports $filter." + "description": "`true` if this group is synced from an on-premises directory;\n`false` if this group was originally synced from an on-premises directory but is no longer synced;\nnull if this object has never been synced from an on-premises directory (default).\nReturned by default. Read-only. Supports $filter." }, "onPremisesImmutableId": { "type": "string", @@ -877,7 +877,7 @@ }, "issuerAssignedId": { "type": "string", - "description": "Specifies the unique identifier assigned to the user by the issuer. The combination of *issuer* and *issuerAssignedId* must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).\nWhen *signInType* is set to:\n* `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) *issuerAssignedId* must be a valid email address\n* `userName`, issuer_assigned_id must be a valid local part of an email address\nSupports $filter. 512 character limit." + "description": "Specifies the unique identifier assigned to the user by the issuer. The combination of *issuer* and *issuerAssignedId* must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts).\nWhen *signInType* is set to:\n* `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) `issuerAssignedId` must be a valid email address\n* `userName`, issuer_assigned_id must be a valid local part of an email address\nSupports $filter. 512 character limit." } }, "description": "Identities Represents an identity used to sign in to a user account.\nAn identity can be provided by oCIS, by organizations, or by social identity providers such as Facebook, Google, or Microsoft, that are tied to a user account.\nThis enables the user to sign in to the user account with any of those associated identities.\nThey are also used to keep a history of old usernames." @@ -1019,11 +1019,11 @@ }, "forceChangePasswordNextSignIn": { "type": "boolean", - "description": "*true* if the user must change her password on the next login; otherwise false." + "description": "`true` if the user must change her password on the next login; otherwise false." }, "forceChangePasswordNextSignInWithMfa": { "type": "boolean", - "description": "If *true*, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false." + "description": "If `true`, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false." } } }, diff --git a/protogen/proto/ocis/messages/accounts/v1/accounts.proto b/protogen/proto/ocis/messages/accounts/v1/accounts.proto index 106b19a6a5..ba4862ba1d 100644 --- a/protogen/proto/ocis/messages/accounts/v1/accounts.proto +++ b/protogen/proto/ocis/messages/accounts/v1/accounts.proto @@ -14,14 +14,14 @@ message Account { // The unique identifier for the user. Key. Not nullable. Non reassignable. Read-only. string id = 1; - // *true* if the account is enabled; otherwise, *false*. This property is required when a user is created. Supports $filter. + // `true` if the account is enabled; otherwise, `false`. This property is required when a user is created. Supports $filter. bool account_enabled = 2; // A resource account is also known as a /disabled user object/ in Azure AD, and can be used to represent resources in general. // In Exchange it might be used to represent conference rooms, for example, and allow them to have a phone number. // You could give printers or machines with a sync client resource accounts as well. // A resource account can be homed in Microsoft 365 or on premises using Skype for Business Server 2019. - // *true* if the user is a resource account; otherwise, *false*. Null value should be considered false. + // `true` if the user is a resource account; otherwise, `false`. Null value should be considered false. bool is_resource_account = 3; // Indicates whether the account was created as @@ -50,6 +50,7 @@ message Account { string preferred_name = 7; // TODO rename to on_premise_? or move to extension? see https://docs.microsoft.com/en-us/graph/extensibility-open-users + // used for exposing the user using ldap // posixaccount MUST uidnumber int64 uid_number = 8; @@ -100,8 +101,8 @@ message Account { // properties for sync - // *true* if this object is synced from an on-premises directory; - // *false* if this object was originally synced from an on-premises directory but is no longer synced; + // `true` if this object is synced from an on-premises directory; + // `false` if this object was originally synced from an on-premises directory but is no longer synced; // null if this object has never been synced from an on-premises directory (default). Read-only bool on_premises_sync_enabled = 20; @@ -186,7 +187,7 @@ message Identities { // Specifies the unique identifier assigned to the user by the issuer. The combination of *issuer* and *issuerAssignedId* must be unique within the organization. Represents the sign-in name for the user, when signInType is set to emailAddress or userName (also known as local accounts). // When *signInType* is set to: - // * `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) *issuerAssignedId* must be a valid email address + // * `emailAddress`, (or starts with `emailAddress` like `emailAddress1`) `issuerAssignedId` must be a valid email address // * `userName`, issuer_assigned_id must be a valid local part of an email address // Supports $filter. 512 character limit. string issuer_assigned_id = 3; @@ -205,10 +206,10 @@ message PasswordProfile { // “DisablePasswordExpiration” can also be specified. repeated string password_policies = 3; - // *true* if the user must change her password on the next login; otherwise false. + // `true` if the user must change her password on the next login; otherwise false. bool force_change_password_next_sign_in = 4; - // If *true*, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. + // If `true`, at next sign-in, the user must perform a multi-factor authentication (MFA) before being forced to change their password. The behavior is identical to forceChangePasswordNextSignIn except that the user is required to first perform a multi-factor authentication before password change. After a password change, this property will be automatically reset to false. If not set, default is false. bool force_change_password_next_sign_in_with_mfa = 5; } @@ -226,8 +227,9 @@ message Group { string display_name = 2; // groupofnames MUST/MAY member - // Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable. // TODO accounts (users) only for now, we can add groups with the dedicated message using oneof construct later + + // Users, contacts, and groups that are members of this group. HTTP Methods: GET (supported for all groups), POST (supported for security groups and mail-enabled security groups), DELETE (supported only for security groups) Read-only. Nullable. repeated Account members = 3; // groupofnames MAY businessCategory @@ -279,8 +281,8 @@ message Group { // properties for sync - // *true* if this group is synced from an on-premises directory; - // *false* if this group was originally synced from an on-premises directory but is no longer synced; + // `true` if this group is synced from an on-premises directory; + // `false` if this group was originally synced from an on-premises directory but is no longer synced; // null if this object has never been synced from an on-premises directory (default). // Returned by default. Read-only. Supports $filter. bool on_premises_sync_enabled = 20;