Skip to content

Commit edcded8

Browse files
committed
Description review
1 parent ac6ac83 commit edcded8

File tree

8 files changed

+25
-24
lines changed

8 files changed

+25
-24
lines changed

docs/domains/Domain.json

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"type": "object",
77
"properties": {
88
"serverStartState": {
9-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
9+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
1010
"type": "string",
1111
"enum": [
1212
"RUNNING",
@@ -76,7 +76,7 @@
7676
"type": "object",
7777
"properties": {
7878
"serverStartState": {
79-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
79+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
8080
"type": "string",
8181
"enum": [
8282
"RUNNING",
@@ -88,7 +88,7 @@
8888
"$ref": "#/definitions/KubernetesResource"
8989
},
9090
"maxUnavailable": {
91-
"description": "The maximum number of cluster membrers that can be temporarily unavailable. Defaults to 1.",
91+
"description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.",
9292
"type": "number",
9393
"minimum": 1
9494
},
@@ -167,7 +167,7 @@
167167
"type": "object",
168168
"properties": {
169169
"serverStartState": {
170-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
170+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
171171
"type": "string",
172172
"enum": [
173173
"RUNNING",
@@ -229,7 +229,7 @@
229229
"type": "string"
230230
},
231231
"configOverrides": {
232-
"description": "The name of the configmap for optional WebLogic configuration overrides.",
232+
"description": "The name of the config map for optional WebLogic configuration overrides.",
233233
"type": "string"
234234
},
235235
"serverService": {
@@ -245,7 +245,7 @@
245245
"type": "boolean"
246246
},
247247
"webLogicCredentialsSecret": {
248-
"description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic under the \u0027username\u0027 and \u0027password\u0027 fields.",
248+
"description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic Server under the \u0027username\u0027 and \u0027password\u0027 fields.",
249249
"$ref": "#/definitions/V1SecretReference"
250250
},
251251
"adminServer": {
@@ -327,7 +327,7 @@
327327
"type": "object",
328328
"properties": {
329329
"serverStartState": {
330-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
330+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
331331
"type": "string",
332332
"enum": [
333333
"RUNNING",

docs/domains/index.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -926,7 +926,7 @@
926926
"type": "object",
927927
"properties": {
928928
"serverStartState": {
929-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
929+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
930930
"type": "string",
931931
"enum": [
932932
"RUNNING",
@@ -996,7 +996,7 @@
996996
"type": "object",
997997
"properties": {
998998
"serverStartState": {
999-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
999+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
10001000
"type": "string",
10011001
"enum": [
10021002
"RUNNING",
@@ -1008,7 +1008,7 @@
10081008
"$ref": "#/definitions/KubernetesResource"
10091009
},
10101010
"maxUnavailable": {
1011-
"description": "The maximum number of cluster membrers that can be temporarily unavailable. Defaults to 1.",
1011+
"description": "The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.",
10121012
"type": "number",
10131013
"minimum": 1.0
10141014
},
@@ -1087,7 +1087,7 @@
10871087
"type": "object",
10881088
"properties": {
10891089
"serverStartState": {
1090-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
1090+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
10911091
"type": "string",
10921092
"enum": [
10931093
"RUNNING",
@@ -1149,7 +1149,7 @@
11491149
"type": "string"
11501150
},
11511151
"configOverrides": {
1152-
"description": "The name of the configmap for optional WebLogic configuration overrides.",
1152+
"description": "The name of the config map for optional WebLogic configuration overrides.",
11531153
"type": "string"
11541154
},
11551155
"serverService": {
@@ -1165,7 +1165,7 @@
11651165
"type": "boolean"
11661166
},
11671167
"webLogicCredentialsSecret": {
1168-
"description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic under the \u0027username\u0027 and \u0027password\u0027 fields.",
1168+
"description": "The name of a pre-created Kubernetes secret, in the domain\u0027s namepace, that holds the username and password needed to boot WebLogic Server under the \u0027username\u0027 and \u0027password\u0027 fields.",
11691169
"$ref": "#/definitions/V1SecretReference"
11701170
},
11711171
"adminServer": {
@@ -1247,7 +1247,7 @@
12471247
"type": "object",
12481248
"properties": {
12491249
"serverStartState": {
1250-
"description": "The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.",
1250+
"description": "The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.",
12511251
"type": "string",
12521252
"enum": [
12531253
"RUNNING",

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/BaseConfiguration.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ public abstract class BaseConfiguration {
3838
/** Desired startup state. Legal values are RUNNING or ADMIN. */
3939
@EnumClass(ServerStartState.class)
4040
@Description(
41-
"The state in which the server is to be started. Use ADMIN if server should start in admin state. Defaults to RUNNING.")
41+
"The state in which the server is to be started. Use ADMIN if server should start in the admin state. Defaults to RUNNING.")
4242
private String serverStartState;
4343

4444
/**

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/Cluster.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ public class Cluster extends BaseConfiguration implements Comparable<Cluster> {
4747
private String serverStartPolicy;
4848

4949
@Description(
50-
"The maximum number of cluster membrers that can be temporarily unavailable. Defaults to 1.")
50+
"The maximum number of cluster members that can be temporarily unavailable. Defaults to 1.")
5151
@Range(minimum = 1)
5252
private Integer maxUnavailable;
5353

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/Domain.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -357,9 +357,9 @@ public List<String> getAdminServerChannelNames() {
357357
}
358358

359359
/**
360-
* Returns the name of the Kubernetes configmap that contains optional configuration overrides.
360+
* Returns the name of the Kubernetes config map that contains optional configuration overrides.
361361
*
362-
* @return name of the configmap
362+
* @return name of the config map
363363
*/
364364
public String getConfigOverrides() {
365365
return spec.getConfigOverrides();

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/DomainSpec.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public class DomainSpec extends BaseConfiguration {
6868
*/
6969
@Description(
7070
"The name of a pre-created Kubernetes secret, in the domain's namepace, that holds"
71-
+ " the username and password needed to boot WebLogic under the 'username' and 'password' fields.")
71+
+ " the username and password needed to boot WebLogic Server under the 'username' and 'password' fields.")
7272
@Valid
7373
@NotNull
7474
private V1SecretReference webLogicCredentialsSecret;
@@ -151,11 +151,11 @@ public class DomainSpec extends BaseConfiguration {
151151
private Boolean domainHomeInImage;
152152

153153
/**
154-
* The name of the Kubernetes configmap used for optional WebLogic configuration overrides.
154+
* The name of the Kubernetes config map used for optional WebLogic configuration overrides.
155155
*
156156
* @since 2.0
157157
*/
158-
@Description("The name of the configmap for optional WebLogic configuration overrides.")
158+
@Description("The name of the config map for optional WebLogic configuration overrides.")
159159
private String configOverrides;
160160

161161
/**

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/DomainV2Configurator.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,9 +81,10 @@ public DomainConfigurator withAdditionalVolumeMount(String name, String path) {
8181

8282
@Override
8383
/**
84-
* Sets the WebLogic configuration overrides configmap name for the domain
84+
* Sets the WebLogic configuration overrides config map name for the domain
8585
*
86-
* @param configMapName Name of the Kubernetes configmap that contains the config overrides
86+
* @param configMapName Name of the Kubernetes config map that contains the configuration
87+
* overrides
8788
* @return this object
8889
*/
8990
public DomainConfigurator withConfigOverrides(String configMapName) {

model/src/main/java/oracle/kubernetes/weblogic/domain/v2/ServerSpec.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ protected List<V1EnvVar> withStateAdjustments(List<V1EnvVar> env) {
8585
}
8686

8787
/**
88-
* The Kubernetes configmap name used in WebLogic configuration overrides
88+
* The Kubernetes config map name used in WebLogic configuration overrides
8989
*
9090
* @return configMapName. May be empty.
9191
*/

0 commit comments

Comments
 (0)