Skip to content

Commit c7512c4

Browse files
committed
docs(ClearlyDefinedService): Clarify what an empty revision means
Signed-off-by: Sebastian Schuberth <[email protected]>
1 parent fda0088 commit c7512c4

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

clients/clearly-defined/src/main/kotlin/ClearlyDefinedService.kt

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ interface ClearlyDefinedService {
223223

224224
/**
225225
* Get the curation for the component described by [type], [provider], [namespace] (use "-" if not applicable),
226-
* [name] and [revision], see
226+
* [name] and [revision] (when empty, the latest revision will be used if that makes sense for the provider), see
227227
* https://api.clearlydefined.io/api-docs/#/curations/get_curations__type___provider___namespace___name___revision_.
228228
*/
229229
@GET("curations/{type}/{provider}/{namespace}/{name}/{revision}")
@@ -257,7 +257,8 @@ interface ClearlyDefinedService {
257257

258258
/**
259259
* Get information about the harvest tools that have produced data for the component described by [type],
260-
* [provider], [namespace] (use "-" if not applicable), [name], and [revision], see
260+
* [provider], [namespace] (use "-" if not applicable), [name], and [revision] (when empty, the latest revision will
261+
* be used if that makes sense for the provider), see
261262
* https://api.clearlydefined.io/api-docs/#/harvest/get_harvest__type___provider___namespace___name___revision_.
262263
* This can be used to quickly find out whether results of a specific tool are already available.
263264
*/
@@ -272,7 +273,8 @@ interface ClearlyDefinedService {
272273

273274
/**
274275
* Get the harvested data for the component described by [type], [provider], [namespace] (use "-" if not
275-
* applicable), [name], and [revision] that was produced by [tool] with version [toolVersion], see
276+
* applicable), [name], and [revision] (when empty, the latest revision will be used if that makes sense for the
277+
* provider) that was produced by [tool] with version [toolVersion], see
276278
* https://api.clearlydefined.io/api-docs/#/harvest/get_harvest__type___provider___namespace___name___revision___tool___toolVersion_
277279
*/
278280
@GET("harvest/{type}/{provider}/{namespace}/{name}/{revision}/{tool}/{toolVersion}?form=streamed")

0 commit comments

Comments
 (0)