Skip to content

Commit 2c60478

Browse files
committed
Update javadoc
1 parent bd93cf0 commit 2c60478

16 files changed

Lines changed: 53 additions & 60 deletions

javadoc/allclasses-index.html

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20300,11 +20300,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
2030020300
</div>
2030120301
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/importapi/models/importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a></div>
2030220302
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
20303-
<div class="block">ImportOperationStatus
20304-
20305-
20306-
Example to create an instance using the builder pattern
20307-
</div>
20303+
<div class="block">The ID and validation status of a new ImportOperation.</div>
2030820304
</div>
2030920305
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/importapi/models/importoperations/ImportOperationStatusBuilder.html" title="class in com.commercetools.importapi.models.importoperations">ImportOperationStatusBuilder</a></div>
2031020306
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">
@@ -20342,7 +20338,7 @@ <h1 title="All Classes and Interfaces" class="title">All Classes and Interfaces<
2034220338
</div>
2034320339
<div class="col-first odd-row-color all-classes-table all-classes-table-tab1"><a href="com/commercetools/importapi/models/importrequests/ImportResponse.html" title="interface in com.commercetools.importapi.models.importrequests">ImportResponse</a></div>
2034420340
<div class="col-last odd-row-color all-classes-table all-classes-table-tab1">
20345-
<div class="block">A list of the ID's and validation statuses of newly created ImportOperations.</div>
20341+
<div class="block">The response of each resource import endpoint, such as Import Categories and Import ProductTypes.</div>
2034620342
</div>
2034720343
<div class="col-first even-row-color all-classes-table all-classes-table-tab2"><a href="com/commercetools/importapi/models/importrequests/ImportResponseBuilder.html" title="class in com.commercetools.importapi.models.importrequests">ImportResponseBuilder</a></div>
2034820344
<div class="col-last even-row-color all-classes-table all-classes-table-tab2">

javadoc/com/commercetools/docs/meta/SizeOptimization.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ <h3>Using split packages</h3>
8989
the split is realized after compilation and doesn't reflect the whole dependency graph of all packages.
9090
You will have to explicitly define the packages you intend to use.</p>
9191

92-
<p>We provide an for using split packages</p>
92+
<p>We provide an <a href=https://github.com/commercetools/commercetools-sdk-java-v2/tree/main/examples/split-packages>example</a> for using split packages</p>
9393

9494
<p>Please see the list for the split packages and their artifact IDs</p>
9595

javadoc/com/commercetools/importapi/models/importoperations/ImportOperationState.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,7 @@ <h2>Field Summary</h2>
115115
<div class="col-first even-row-color"><code>static final <a href="ImportOperationState.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationState</a></code></div>
116116
<div class="col-second even-row-color"><code><a href="#PROCESSING" class="member-name-link">PROCESSING</a></code></div>
117117
<div class="col-last even-row-color">
118-
<div class="block">This is an initial state of import resource and is currently processing.</div>
118+
<div class="block">The import is in process.</div>
119119
</div>
120120
<div class="col-first odd-row-color"><code>static final <a href="ImportOperationState.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationState</a></code></div>
121121
<div class="col-second odd-row-color"><code><a href="#VALIDATION_FAILED" class="member-name-link">VALIDATION_FAILED</a></code></div>
@@ -185,7 +185,7 @@ <h2>Field Details</h2>
185185
<section class="detail" id="PROCESSING">
186186
<h3>PROCESSING</h3>
187187
<div class="member-signature"><span class="modifiers">static final</span>&nbsp;<span class="return-type"><a href="ImportOperationState.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationState</a></span>&nbsp;<span class="element-name">PROCESSING</span></div>
188-
<div class="block"><p>This is an initial state of import resource and is currently processing.</p></div>
188+
<div class="block"><p>The import is in process. This is the initial state of the ImportOperation.</p></div>
189189
</section>
190190
</li>
191191
<li>

javadoc/com/commercetools/importapi/models/importoperations/ImportOperationStatus.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h1 title="Interface ImportOperationStatus" class="title">Interface ImportOperat
7373
<section class="class-description" id="class-description">
7474
<hr>
7575
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ImportOperationStatus</span></div>
76-
<div class="block">ImportOperationStatus
76+
<div class="block"><p>The ID and validation status of a new ImportOperation.</p>
7777

7878
<hr>
7979
Example to create an instance using the builder pattern

javadoc/com/commercetools/importapi/models/importoperations/package-summary.html

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -104,11 +104,7 @@ <h1 title="Package com.commercetools.importapi.models.importoperations" class="t
104104
</div>
105105
<div class="col-first even-row-color class-summary class-summary-tab1"><a href="ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a></div>
106106
<div class="col-last even-row-color class-summary class-summary-tab1">
107-
<div class="block">ImportOperationStatus
108-
109-
110-
Example to create an instance using the builder pattern
111-
</div>
107+
<div class="block">The ID and validation status of a new ImportOperation.</div>
112108
</div>
113109
<div class="col-first odd-row-color class-summary class-summary-tab2"><a href="ImportOperationStatusBuilder.html" title="class in com.commercetools.importapi.models.importoperations">ImportOperationStatusBuilder</a></div>
114110
<div class="col-last odd-row-color class-summary class-summary-tab2">

javadoc/com/commercetools/importapi/models/importrequests/ImportResponse.html

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ <h1 title="Interface ImportResponse" class="title">Interface ImportResponse</h1>
7373
<section class="class-description" id="class-description">
7474
<hr>
7575
<div class="type-signature"><span class="modifiers">public interface </span><span class="element-name type-name-label">ImportResponse</span></div>
76-
<div class="block"><p>A list of the ID's and validation statuses of newly created ImportOperations. Used as a response at each resource-specific import endpoint, for example, at Import Categories and Import ProductTypes.</p>
76+
<div class="block"><p>The response of each resource import endpoint, such as Import Categories and Import ProductTypes.</p>
7777

7878
<hr>
7979
Example to create an instance using the builder pattern
@@ -118,7 +118,9 @@ <h2>Method Summary</h2>
118118
</div>
119119
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>@NotNull @Valid <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>&gt;</code></div>
120120
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#getOperationStatus()" class="member-name-link">getOperationStatus</a>()</code></div>
121-
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">&nbsp;</div>
121+
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
122+
<div class="block">A list of the ID's and validation statuses of new ImportOperations.</div>
123+
</div>
122124
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static <a href="ImportResponse.html" title="interface in com.commercetools.importapi.models.importrequests">ImportResponse</a></code></div>
123125
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#of()" class="member-name-link">of</a>()</code></div>
124126
<div class="col-last odd-row-color method-summary-table method-summary-table-tab1">
@@ -132,12 +134,12 @@ <h2>Method Summary</h2>
132134
<div class="col-first odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
133135
<div class="col-second odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setOperationStatus(com.commercetools.importapi.models.importoperations.ImportOperationStatus...)" class="member-name-link">setOperationStatus</a><wbr>(<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>...&nbsp;operationStatus)</code></div>
134136
<div class="col-last odd-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
135-
<div class="block">set operationStatus</div>
137+
<div class="block">A list of the ID's and validation statuses of new ImportOperations.</div>
136138
</div>
137139
<div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code>void</code></div>
138140
<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3"><code><a href="#setOperationStatus(java.util.List)" class="member-name-link">setOperationStatus</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>&gt;&nbsp;operationStatus)</code></div>
139141
<div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab3">
140-
<div class="block">set operationStatus</div>
142+
<div class="block">A list of the ID's and validation statuses of new ImportOperations.</div>
141143
</div>
142144
<div class="col-first odd-row-color method-summary-table method-summary-table-tab1"><code>static com.fasterxml.jackson.core.type.TypeReference&lt;<a href="ImportResponse.html" title="interface in com.commercetools.importapi.models.importrequests">ImportResponse</a>&gt;</code></div>
143145
<div class="col-second odd-row-color method-summary-table method-summary-table-tab1"><code><a href="#typeReference()" class="member-name-link">typeReference</a>()</code></div>
@@ -169,6 +171,7 @@ <h3>getOperationStatus</h3>
169171
<div class="member-signature"><span class="annotations">@NotNull
170172
@Valid
171173
</span><span class="return-type">@NotNull @Valid <a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>&gt;</span>&nbsp;<span class="element-name">getOperationStatus</span>()</div>
174+
<div class="block"><p>A list of the ID's and validation statuses of new ImportOperations.</p></div>
172175
<dl class="notes">
173176
<dt>Returns:</dt>
174177
<dd>operationStatus</dd>
@@ -179,7 +182,7 @@ <h3>getOperationStatus</h3>
179182
<section class="detail" id="setOperationStatus(com.commercetools.importapi.models.importoperations.ImportOperationStatus...)">
180183
<h3>setOperationStatus</h3>
181184
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setOperationStatus</span><wbr><span class="parameters">(<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>...&nbsp;operationStatus)</span></div>
182-
<div class="block">set operationStatus</div>
185+
<div class="block"><p>A list of the ID's and validation statuses of new ImportOperations.</p></div>
183186
<dl class="notes">
184187
<dt>Parameters:</dt>
185188
<dd><code>operationStatus</code> - values to be set</dd>
@@ -190,7 +193,7 @@ <h3>setOperationStatus</h3>
190193
<section class="detail" id="setOperationStatus(java.util.List)">
191194
<h3>setOperationStatus</h3>
192195
<div class="member-signature"><span class="return-type">void</span>&nbsp;<span class="element-name">setOperationStatus</span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/List.html" title="class or interface in java.util" class="external-link">List</a>&lt;<a href="../importoperations/ImportOperationStatus.html" title="interface in com.commercetools.importapi.models.importoperations">ImportOperationStatus</a>&gt;&nbsp;operationStatus)</span></div>
193-
<div class="block">set operationStatus</div>
196+
<div class="block"><p>A list of the ID's and validation statuses of new ImportOperations.</p></div>
194197
<dl class="notes">
195198
<dt>Parameters:</dt>
196199
<dd><code>operationStatus</code> - values to be set</dd>

0 commit comments

Comments
 (0)