diff --git a/README.md b/README.md index 3cf22878..6121c193 100644 --- a/README.md +++ b/README.md @@ -26,8 +26,10 @@ TODO ## Configuration -The configuration of the service is done by toml config, default one is `config.toml` in working directory, -but it can be overwritten by `INSIGHTS_RESULTS_SMART_PROXY_CONFIG_FILE` env var. +The configuration of the service is done by config written in +[TOML language](https://toml.io/en/). Default one is `config.toml` in working +directory, but it can be overwritten by +`INSIGHTS_RESULTS_SMART_PROXY_CONFIG_FILE` env var. Also each key in config can be overwritten by corresponding env var. For example if you have config diff --git a/docs/packages/types/types.html b/docs/packages/types/types.html index 6f67aeaa..fa9c8a20 100644 --- a/docs/packages/types/types.html +++ b/docs/packages/types/types.html @@ -130,6 +130,15 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

+ +
+ + + +

Package types contains all user-defined data types used in Smart Proxy REST +API service. Some types are the same as in other services (especially in +Insights Results Aggregator, Content Service) and thus they are imported +(based on) the common package insights-operator-utils/types.

package
types
@@ -209,6 +218,7 @@

UserVoteDislike shows user's dislike

	
UserVoteDislike
=
types
.
UserVoteDislike
+
@@ -216,6 +226,7 @@

UserVoteNone shows no vote from user

	
UserVoteNone
=
types
.
UserVoteNone
+
diff --git a/types/types.go b/types/types.go index db965207..151f5b1e 100644 --- a/types/types.go +++ b/types/types.go @@ -12,6 +12,10 @@ // See the License for the specific language governing permissions and // limitations under the License. +// Package types contains all user-defined data types used in Smart Proxy REST +// API service. Some types are the same as in other services (especially in +// Insights Results Aggregator, Content Service) and thus they are imported +// (based on) the common package insights-operator-utils/types. package types import "github.com/RedHatInsights/insights-operator-utils/types" @@ -55,8 +59,10 @@ type UserVote = types.UserVote const ( // UserVoteDislike shows user's dislike UserVoteDislike = types.UserVoteDislike + // UserVoteNone shows no vote from user UserVoteNone = types.UserVoteNone + // UserVoteLike shows user's like UserVoteLike = types.UserVoteLike )