From 675c6ecc18505c3f4cd4b599015875f2ca1ae000 Mon Sep 17 00:00:00 2001 From: Viktor Scharf Date: Fri, 31 Mar 2023 07:45:47 +0000 Subject: [PATCH] [api-test] first notification test (#5958) * notification test * fix after review * fix lint --- .../_includes/adoc/global_configvars.adoc | 48 +++++++++---------- services/antivirus/_index.md | 2 +- services/audit/_index.md | 2 +- services/auth-basic/_index.md | 2 +- services/auth-bearer/_index.md | 2 +- services/eventhistory/_index.md | 2 +- services/frontend/_index.md | 2 +- services/graph/_index.md | 2 +- services/idm/_index.md | 2 +- services/idp/_index.md | 2 +- services/invitations/_index.md | 2 +- services/nats/_index.md | 2 +- services/notifications/_index.md | 2 +- services/policies/_index.md | 2 +- services/postprocessing/_index.md | 2 +- services/proxy/_index.md | 2 +- services/search/_index.md | 2 +- services/storage-system/_index.md | 2 +- services/storage-users/_index.md | 2 +- services/thumbnails/_index.md | 2 +- services/userlog/_index.md | 2 +- services/web/_index.md | 2 +- services/webdav/_index.md | 2 +- services/webfinger/_index.md | 2 +- 24 files changed, 47 insertions(+), 47 deletions(-) diff --git a/services/_includes/adoc/global_configvars.adoc b/services/_includes/adoc/global_configvars.adoc index f3a71cf1ea0..254ca54301c 100644 --- a/services/_includes/adoc/global_configvars.adoc +++ b/services/_includes/adoc/global_configvars.adoc @@ -163,7 +163,7 @@ a| [subs=-attributes] ++groupOfNames ++ a| [subs=-attributes] -The object class to use for groups in the default group search filter ('groupOfNames'). +The object class to use for groups in the default group search filter like 'groupOfNames'. a| `LDAP_GROUP_SCHEMA_DISPLAYNAME` @@ -213,7 +213,7 @@ a| [subs=-attributes] ++ownclouduuid ++ a| [subs=-attributes] -LDAP Attribute to use as the unique id for groups. This should be a stable globally unique id (e.g. a UUID). +LDAP Attribute to use as the unique ID for groups. This should be a stable globally unique ID like a UUID. a| `LDAP_GROUP_SCHEMA_ID_IS_OCTETSTRING` @@ -229,7 +229,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group IDs. +Set this to true if the defined 'id' attribute for groups is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the group ID's. a| `LDAP_GROUP_SCHEMA_MAIL` @@ -385,7 +385,7 @@ a| [subs=-attributes] ++inetOrgPerson ++ a| [subs=-attributes] -The object class to use for users in the default user search filter ('inetOrgPerson'). +The object class to use for users in the default user search filter like 'inetOrgPerson'. a| `LDAP_USER_SCHEMA_DISPLAYNAME` @@ -419,7 +419,7 @@ a| [subs=-attributes] ++ownclouduuid ++ a| [subs=-attributes] -LDAP Attribute to use as the unique id for users. This should be a stable globally unique ID like a UUID. +LDAP Attribute to use as the unique id for users. This should be a stable globally unique id like a UUID. a| `LDAP_USER_SCHEMA_ID_IS_OCTETSTRING` @@ -435,7 +435,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true if the defined 'id' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user IDs. +Set this to true if the defined 'id' attribute for users is of the 'OCTETSTRING' syntax. This is e.g. required when using the 'objectGUID' attribute of Active Directory for the user ID's. a| `LDAP_USER_SCHEMA_MAIL` @@ -483,7 +483,7 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ownCloudUserType ++ +++ ++ a| [subs=-attributes] LDAP Attribute to distinguish between 'Member' and 'Guest' users. Default is 'ownCloudUserType'. @@ -571,7 +571,7 @@ a| [subs=-attributes] ++[] ++ a| [subs=-attributes] -A comma separated list of nodes to access the configured store. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. +A comma-separated list of nodes to connect to. This has no effect when 'in-memory' stores are configured. Note that the behaviour how nodes are used is dependent on the library of the configured store. a| `OCIS_CACHE_STORE_NODES` @@ -619,13 +619,13 @@ a| [subs=attributes+] * xref:{s-path}/proxy.adoc[proxy] + a| [subs=-attributes] -++Duration ++ +++int ++ a| [subs=-attributes] -++0s ++ +++300 ++ a| [subs=-attributes] -Time to live for events in the store. The duration can be set as number followed by a unit identifier like s, m or h. Defaults to '336h' (2 weeks). +Max TTL in seconds for the gateway's stat cache. a| `OCIS_CACHE_STORE_TYPE` @@ -640,10 +640,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++ ++ +++memory ++ a| [subs=-attributes] -The type of the cache store. Supported values are: 'memory', 'ocmem', 'etcd', 'redis', 'redis-sentinel', 'nats-js', 'noop'. See the text description for details. +Store implementation for the cache. Valid values are "memory" (default), "redis", and "etcd". a| `OCIS_CORS_ALLOW_CREDENTIALS` @@ -763,7 +763,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services.. +Enable TLS for the connection to the events broker. The events broker is the ocis service which receives and delivers events between the services. a| `OCIS_GRPC_CLIENT_TLS_CACERT` @@ -928,7 +928,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Whether to verify the server TLS certificates. +Allow insecure connections to the frontend. a| `OCIS_JWT_SECRET` @@ -1183,7 +1183,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -Machine auth API key used to validate internal requests necessary to access resources from other services. +The machine auth API key used to validate internal requests necessary to access resources from other services. a| `OCIS_OIDC_ISSUER` @@ -1201,10 +1201,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://localhost:9200 ++ +++ ++ a| [subs=-attributes] -The identity provider value to set in the userids of the CS3 user objects for users returned by this user provider. +The identity provider href for the openid-discovery relation. a| `OCIS_PERSISTENT_STORE` @@ -1249,7 +1249,7 @@ a| [subs=-attributes] ++false ++ a| [subs=-attributes] -Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. If not using the global OCIS_SHARING_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD, you must define the FRONTEND_OCS_PUBLIC_WRITEABLE_SHARE_MUST_HAVE_PASSWORD in the frontend service. +Set this to true if you want to enforce passwords on Uploader, Editor or Contributor shares. a| `OCIS_SPACES_MAX_QUOTA` @@ -1264,7 +1264,7 @@ a| [subs=-attributes] ++0 ++ a| [subs=-attributes] -Set a global max quota for spaces in bytes. A value of 0 equals unlimited. If not using the global OCIS_SPACES_MAX_QUOTA, you must define the FRONTEND_MAX_QUOTA in the frontend service. +Set the global max quota value in bytes. A value of 0 equals unlimited. The value is provided via capabilities. a| `OCIS_SYSTEM_USER_API_KEY` @@ -1302,7 +1302,7 @@ a| [subs=-attributes] ++ ++ a| [subs=-attributes] -ID of the oCIS STORAGE-SYSTEM system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. +ID of the oCIS storage-system system user. Admins need to set the ID for the STORAGE-SYSTEM system user in this config option which is then used to reference the user. Any reasonable long string is possible, preferably this would be an UUIDv4 format. a| `OCIS_SYSTEM_USER_IDP` @@ -1512,10 +1512,10 @@ a| [subs=-attributes] ++string ++ a| [subs=-attributes] -++https://localhost:9200 ++ +++ ++ a| [subs=-attributes] -The public facing URL of the oCIS Web UI, used e.g. when sending notification eMails +The identity provider href for the openid-discovery relation. a| `REVA_GATEWAY` @@ -1552,7 +1552,7 @@ a| [subs=-attributes] ++127.0.0.1:9142 ++ a| [subs=-attributes] -CS3 gateway used to look up user metadata +The CS3 gateway endpoint. a| `STORAGE_TRANSFER_SECRET` diff --git a/services/antivirus/_index.md b/services/antivirus/_index.md index 5f36662dc6e..c1ed342a457 100644 --- a/services/antivirus/_index.md +++ b/services/antivirus/_index.md @@ -1,6 +1,6 @@ --- title: Antivirus Service -date: 2023-03-31T06:12:21.242557481Z +date: 2023-03-31T07:43:38.777655753Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/antivirus diff --git a/services/audit/_index.md b/services/audit/_index.md index 0373ef26206..ecaf39aee81 100644 --- a/services/audit/_index.md +++ b/services/audit/_index.md @@ -1,6 +1,6 @@ --- title: Audit service -date: 2023-03-31T06:12:21.242804496Z +date: 2023-03-31T07:43:38.777830765Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/audit diff --git a/services/auth-basic/_index.md b/services/auth-basic/_index.md index a175d7265ed..88a5d2b9d1b 100644 --- a/services/auth-basic/_index.md +++ b/services/auth-basic/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Basic Service -date: 2023-03-31T06:12:21.243037015Z +date: 2023-03-31T07:43:38.777942958Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/auth-basic diff --git a/services/auth-bearer/_index.md b/services/auth-bearer/_index.md index 3f69ce3b07a..8fa343787d5 100644 --- a/services/auth-bearer/_index.md +++ b/services/auth-bearer/_index.md @@ -1,6 +1,6 @@ --- title: Auth-Bearer Service -date: 2023-03-31T06:12:21.24322025Z +date: 2023-03-31T07:43:38.778059408Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/auth-bearer diff --git a/services/eventhistory/_index.md b/services/eventhistory/_index.md index c12a06aa374..7f90d310ca9 100644 --- a/services/eventhistory/_index.md +++ b/services/eventhistory/_index.md @@ -1,6 +1,6 @@ --- title: Eventhistory Service -date: 2023-03-31T06:12:21.243387525Z +date: 2023-03-31T07:43:38.778158596Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/eventhistory diff --git a/services/frontend/_index.md b/services/frontend/_index.md index 34bf3b455ff..917fe44ea9a 100644 --- a/services/frontend/_index.md +++ b/services/frontend/_index.md @@ -1,6 +1,6 @@ --- title: Frontend Service -date: 2023-03-31T06:12:21.243577653Z +date: 2023-03-31T07:43:38.77825578Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/frontend diff --git a/services/graph/_index.md b/services/graph/_index.md index d906efb3601..6cb549522f4 100644 --- a/services/graph/_index.md +++ b/services/graph/_index.md @@ -1,6 +1,6 @@ --- title: Graph service -date: 2023-03-31T06:12:21.243763524Z +date: 2023-03-31T07:43:38.778355791Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/graph diff --git a/services/idm/_index.md b/services/idm/_index.md index 4d24227b20d..e1a161a6feb 100644 --- a/services/idm/_index.md +++ b/services/idm/_index.md @@ -1,6 +1,6 @@ --- title: Idm -date: 2023-03-31T06:12:21.243940968Z +date: 2023-03-31T07:43:38.778452765Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/idm diff --git a/services/idp/_index.md b/services/idp/_index.md index 6a1ad0baca5..e801251b833 100644 --- a/services/idp/_index.md +++ b/services/idp/_index.md @@ -1,6 +1,6 @@ --- title: IDP Service -date: 2023-03-31T06:12:21.244106701Z +date: 2023-03-31T07:43:38.77854494Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/idp diff --git a/services/invitations/_index.md b/services/invitations/_index.md index 3f379eb1fd5..102353c3e87 100644 --- a/services/invitations/_index.md +++ b/services/invitations/_index.md @@ -1,6 +1,6 @@ --- title: Invitations Service -date: 2023-03-31T06:12:21.244279706Z +date: 2023-03-31T07:43:38.778635552Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/invitations diff --git a/services/nats/_index.md b/services/nats/_index.md index 6d657adf542..9e8939b99cf 100644 --- a/services/nats/_index.md +++ b/services/nats/_index.md @@ -1,6 +1,6 @@ --- title: Nats Service -date: 2023-03-31T06:12:21.244450528Z +date: 2023-03-31T07:43:38.778736393Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/nats diff --git a/services/notifications/_index.md b/services/notifications/_index.md index fa4dafdb9cb..c5688a36edd 100644 --- a/services/notifications/_index.md +++ b/services/notifications/_index.md @@ -1,6 +1,6 @@ --- title: Notification service -date: 2023-03-31T06:12:21.24467438Z +date: 2023-03-31T07:43:38.7788355Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/notifications diff --git a/services/policies/_index.md b/services/policies/_index.md index 389e11d9311..352cbb4d901 100644 --- a/services/policies/_index.md +++ b/services/policies/_index.md @@ -1,6 +1,6 @@ --- title: Policies Service -date: 2023-03-31T06:12:21.244887693Z +date: 2023-03-31T07:43:38.778948696Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/policies diff --git a/services/postprocessing/_index.md b/services/postprocessing/_index.md index aa2bcba1aca..81782b82da7 100644 --- a/services/postprocessing/_index.md +++ b/services/postprocessing/_index.md @@ -1,6 +1,6 @@ --- title: Postprocessing Service -date: 2023-03-31T06:12:21.245114309Z +date: 2023-03-31T07:43:38.779101425Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/postprocessing diff --git a/services/proxy/_index.md b/services/proxy/_index.md index 8cd199d861c..5a4878b75b1 100644 --- a/services/proxy/_index.md +++ b/services/proxy/_index.md @@ -1,6 +1,6 @@ --- title: Proxy Service -date: 2023-03-31T06:12:21.245354302Z +date: 2023-03-31T07:43:38.779244817Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/proxy diff --git a/services/search/_index.md b/services/search/_index.md index 7aa1517374e..74bad0babb9 100644 --- a/services/search/_index.md +++ b/services/search/_index.md @@ -1,6 +1,6 @@ --- title: Search Service -date: 2023-03-31T06:12:21.245582802Z +date: 2023-03-31T07:43:38.779409009Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/search diff --git a/services/storage-system/_index.md b/services/storage-system/_index.md index 8c74798041a..6d1bd50e920 100644 --- a/services/storage-system/_index.md +++ b/services/storage-system/_index.md @@ -1,6 +1,6 @@ --- title: Storage-System Service -date: 2023-03-31T06:12:21.245826351Z +date: 2023-03-31T07:43:38.779553774Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/storage-system diff --git a/services/storage-users/_index.md b/services/storage-users/_index.md index 61a185231e4..8ef923fe6e4 100644 --- a/services/storage-users/_index.md +++ b/services/storage-users/_index.md @@ -1,6 +1,6 @@ --- title: Storage-Users Service -date: 2023-03-31T06:12:21.246030996Z +date: 2023-03-31T07:43:38.779676697Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/storage-users diff --git a/services/thumbnails/_index.md b/services/thumbnails/_index.md index 4f1b45e0ea6..a900fb38b20 100644 --- a/services/thumbnails/_index.md +++ b/services/thumbnails/_index.md @@ -1,6 +1,6 @@ --- title: Thumbnails Service -date: 2023-03-31T06:12:21.246223009Z +date: 2023-03-31T07:43:38.779813867Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/thumbnails diff --git a/services/userlog/_index.md b/services/userlog/_index.md index d58949a8b9d..68b6d3e93fc 100644 --- a/services/userlog/_index.md +++ b/services/userlog/_index.md @@ -1,6 +1,6 @@ --- title: Userlog Service -date: 2023-03-31T06:12:21.246426813Z +date: 2023-03-31T07:43:38.779913005Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/userlog diff --git a/services/web/_index.md b/services/web/_index.md index dabefb81b9d..3e657e64508 100644 --- a/services/web/_index.md +++ b/services/web/_index.md @@ -1,6 +1,6 @@ --- title: Web Service -date: 2023-03-31T06:12:21.246603505Z +date: 2023-03-31T07:43:38.780031961Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/web diff --git a/services/webdav/_index.md b/services/webdav/_index.md index 952ccb80bbe..dbe16e18285 100644 --- a/services/webdav/_index.md +++ b/services/webdav/_index.md @@ -1,6 +1,6 @@ --- title: Webdav Service -date: 2023-03-31T06:12:21.246784086Z +date: 2023-03-31T07:43:38.780127583Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/webdav diff --git a/services/webfinger/_index.md b/services/webfinger/_index.md index 6133bc385f7..5fd5d5d12da 100644 --- a/services/webfinger/_index.md +++ b/services/webfinger/_index.md @@ -1,6 +1,6 @@ --- title: Webfinger Service -date: 2023-03-31T06:12:21.24700878Z +date: 2023-03-31T07:43:38.780247369Z weight: 20 geekdocRepo: https://github.com/owncloud/ocis geekdocEditPath: edit/master/docs/services/webfinger