Repository: incubator-unomi Updated Branches: refs/heads/master 845eeb514 -> 76433205c
UNOMI-142 The JSON property "requireSegments" is misspelt in http://unomi.apache.org/versions/1.1/getting-started.html - Fix typos Signed-off-by: Serge Huber <[email protected]> Project: http://git-wip-us.apache.org/repos/asf/incubator-unomi/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-unomi/commit/76433205 Tree: http://git-wip-us.apache.org/repos/asf/incubator-unomi/tree/76433205 Diff: http://git-wip-us.apache.org/repos/asf/incubator-unomi/diff/76433205 Branch: refs/heads/master Commit: 76433205c33007c77c4aef89ec220cadb70feb6e Parents: 845eeb5 Author: Serge Huber <[email protected]> Authored: Wed Nov 29 15:52:10 2017 +0100 Committer: Serge Huber <[email protected]> Committed: Wed Nov 29 15:52:10 2017 +0100 ---------------------------------------------------------------------- src/site/markdown/versions/1.1/getting-started.md | 4 ++-- src/site/markdown/versions/1.2/twitter-sample.md | 4 ++-- src/site/markdown/versions/master/twitter-sample.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/76433205/src/site/markdown/versions/1.1/getting-started.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.1/getting-started.md b/src/site/markdown/versions/1.1/getting-started.md index 35aedc2..6303c78 100644 --- a/src/site/markdown/versions/1.1/getting-started.md +++ b/src/site/markdown/versions/1.1/getting-started.md @@ -203,7 +203,7 @@ Let's look at the context request structure: - profileProperties: <optional map of property name / value pairs>, - scores: <optional map of score id / value pairs> sessionPropertiesOverrides: <optional map of property name / value pairs>, - requiresSegments: <boolean, whether to return the associated segments> + requireSegments: <boolean, whether to return the associated segments> } ``` @@ -219,7 +219,7 @@ A client wishing to perform content personalization might also specify filtering It is also possible for clients wishing to perform user impersonation to specify properties, segments or scores to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request. #### Controlling the content of the response -The clients can also specify which information to include in the response by setting the `requiresSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. +The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted). http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/76433205/src/site/markdown/versions/1.2/twitter-sample.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/1.2/twitter-sample.md b/src/site/markdown/versions/1.2/twitter-sample.md index f4829df..938055e 100644 --- a/src/site/markdown/versions/1.2/twitter-sample.md +++ b/src/site/markdown/versions/1.2/twitter-sample.md @@ -180,7 +180,7 @@ Let's look at the context request structure: - profileProperties: <optional map of property name / value pairs>, - scores: <optional map of score id / value pairs> sessionPropertiesOverrides: <optional map of property name / value pairs>, - requiresSegments: <boolean, whether to return the associated segments> + requireSegments: <boolean, whether to return the associated segments> } ``` @@ -196,7 +196,7 @@ A client wishing to perform content personalization might also specify filtering It is also possible for clients wishing to perform user impersonation to specify properties or segments to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request. #### Controlling the content of the response -The clients can also specify which information to include in the response by setting the `requiresSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. +The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted). http://git-wip-us.apache.org/repos/asf/incubator-unomi/blob/76433205/src/site/markdown/versions/master/twitter-sample.md ---------------------------------------------------------------------- diff --git a/src/site/markdown/versions/master/twitter-sample.md b/src/site/markdown/versions/master/twitter-sample.md index cf80da2..27b0d56 100644 --- a/src/site/markdown/versions/master/twitter-sample.md +++ b/src/site/markdown/versions/master/twitter-sample.md @@ -180,7 +180,7 @@ Let's look at the context request structure: - profileProperties: <optional map of property name / value pairs>, - scores: <optional map of score id / value pairs> sessionPropertiesOverrides: <optional map of property name / value pairs>, - requiresSegments: <boolean, whether to return the associated segments> + requireSegments: <boolean, whether to return the associated segments> } ``` @@ -196,7 +196,7 @@ A client wishing to perform content personalization might also specify filtering It is also possible for clients wishing to perform user impersonation to specify properties or segments to override the proper ones so as to emulate a specific profile, in which case the overridden value will temporarily replace the proper values so that all rules will be evaluated with these values instead of the proper ones. The `segments` (array of segment identifiers), `profileProperties` (maps of property name and associated object value) and `scores` (maps of score id and value) all wrapped in a profileOverrides object and the `sessionPropertiesOverrides` (maps of property name and associated object value) fields allow to provide such information. Providing such overrides will, of course, impact content filtering results and segments matching for this specific request. #### Controlling the content of the response -The clients can also specify which information to include in the response by setting the `requiresSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. +The clients can also specify which information to include in the response by setting the `requireSegments` property to true if segments the current profile matches should be returned or provide an array of property identifiers for `requiredProfileProperties` or `requiredSessionProperties` fields to ask the context server to return the values for the specified profile or session properties, respectively. This information is provided by the `profileProperties`, `sessionProperties` and `profileSegments` fields of the context server response. Additionally, the context server will also returns any tracked conditions associated with the source of the context request. Upon evaluating the incoming request, the context server will determine if there are any rules marked with the `trackedCondition` tag and which source condition matches the source of the incoming request and return these tracked conditions to the client. The client can use these tracked conditions to learn that the context server can react to events matching the tracked condition and coming from that source. This is, in particular, used to implement form mapping (a solution that allows clients to update user profiles based on values provided when a form is submitted).
