Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Bump GE API spec version to 2023.1 #42

Merged
merged 2 commits into from
Jun 29, 2023
Merged

Conversation

github-actions[bot]
Copy link
Contributor

@github-actions github-actions bot commented Apr 21, 2023

@gabrielfeo gabrielfeo closed this Apr 21, 2023
@gabrielfeo gabrielfeo reopened this Apr 21, 2023
@github-actions
Copy link
Contributor Author

github-actions bot commented Apr 21, 2023

Generated API diff

diff -ur ./base-ref-api/.openapi-generator/FILES ./pr-ref-api/.openapi-generator/FILES
--- ./base-ref-api/.openapi-generator/FILES	2023-06-29 05:42:29.795798870 +0000
+++ ./pr-ref-api/.openapi-generator/FILES	2023-06-29 05:42:11.551804434 +0000
@@ -54,5 +54,6 @@
 src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionAgentPoolPage.kt
 src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionAgentPoolStatus.kt
 src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKey.kt
+src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyDescription.kt
 src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt
 src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefixPage.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt	2023-06-29 05:42:30.147798796 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/TestDistributionApi.kt	2023-06-29 05:42:11.803804336 +0000
@@ -63,10 +63,11 @@
      *  - 403: The authenticated user has insufficient permissions.
      *  - 404: No API key was specified in the request, the key has been revoked or the user bearing the key lacks permissions for this operation.
      *
+     * @param testDistributionApiKeyDescription  (optional)
      * @return [TestDistributionApiKey]
      */
     @POST("api/test-distribution/api-keys")
-    suspend fun generateTestDistributionApiKey(): TestDistributionApiKey
+    suspend fun generateTestDistributionApiKey(@Body testDistributionApiKeyDescription: TestDistributionApiKeyDescription? = null): TestDistributionApiKey
 
     /**
      * View the properties of an Agent Pool
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt	2023-06-29 05:42:29.111799015 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildCachePerformanceTaskExecutionEntry.kt	2023-06-29 05:42:10.863804701 +0000
@@ -31,6 +31,7 @@
  * @param nonCacheabilityCategory The category of the non-cacheability reason:   * `build_cache_not_enabled` - Caching has not been enabled for the build   * `cache-if_condition_not_matched` - Caching was disabled for the task via `org.gradle.api.tasks.TaskOutputs#cacheIf`   * `disabled_to_ensure_correctness` - The task failed validation. Available since Gradle 7.0   * `do-not-cache-if_condition_matched` - Caching was disabled for the task via `org.gradle.api.tasks.TaskOutputs#doNotCacheIf`   * `multiple_outputs_declared` - The task declared multiple outputs   * `no_outputs_declared` - The task had no outputs declared   * `non_cacheable_inputs` - One of the task inputs was not cacheable, either because some type used as an input to the task was loaded via a custom classloader, or a Java lambda was used as an input. Available since Gradle 5.0 and before Gradle 7.5   * `non_cacheable_task_action` - One of the task actions was not cacheable, either because it was loaded via a custom classloader, or a Java lambda was used to implement it. Available since Gradle 5.0 and before Gradle 7.5   * `non_cacheable_task_implementation` - The task implementation was not cacheable, either because it was loaded via a custom classloader, or a Java lambda was used to implement it. Available since Gradle 5.0 and before Gradle 7.5   * `non_cacheable_tree_output` - The task had a `org.gradle.api.file.FileTree` or a `org.gradle.api.internal.file.collections.DirectoryFileTree` as an output. Available since Gradle 5.0   * `overlapping_outputs` - The tasks outputs overlapped with another task. As Gradle cannot safely determine which task each output file belongs to, it disabled caching               * `task_has_no_actions` - The task did not declare any actions   * `task_output_caching_not_enabled` - Caching has not been enabled for the task   * `unknown` - Reason for disabled caching was not known  May be `null` when the task was cacheable or if the information was not available. 
  * @param nonCacheabilityReason The human-readable reason for a non-cacheable task. May be `null` when the task was cacheable or if the information was not available.
  * @param skipReasonMessage The detailed reason why the task was skipped. May be `null` if the task was not skipped or Gradle versions <7.6 are used.
+ * @param cacheArtifactSize The number of bytes of the produced or consumed cache artifact. For a task execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a task execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the task is not cacheable, or if the attempt to store or load the artifact from cache did not succeed. 
  */
 
 
@@ -70,7 +71,11 @@
 
     /* The detailed reason why the task was skipped. May be `null` if the task was not skipped or Gradle versions <7.6 are used. */
     @Json(name = "skipReasonMessage")
-    val skipReasonMessage: kotlin.String? = null
+    val skipReasonMessage: kotlin.String? = null,
+
+    /* The number of bytes of the produced or consumed cache artifact. For a task execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a task execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the task is not cacheable, or if the attempt to store or load the artifact from cache did not succeed.  */
+    @Json(name = "cacheArtifactSize")
+    val cacheArtifactSize: kotlin.Long? = null
 
 ) {
 
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildOptions.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildOptions.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildOptions.kt	2023-06-29 05:42:29.135799009 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/GradleBuildOptions.kt	2023-06-29 05:42:10.891804690 +0000
@@ -27,6 +27,7 @@
  * @param continueOnFailureEnabled Whether continue on failure mode was set for the build. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:continue_build_on_failure.
  * @param daemonEnabled Whether the build was run with the Gradle Daemon. See https://docs.gradle.org/current/userguide/gradle_daemon.html.
  * @param dryRunEnabled Whether the dry run flag was set for the build. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_execution_options.
+ * @param excludedTasks The list of excluded tasks. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:excluding_tasks_from_the_command_line.
  * @param maxNumberOfGradleWorkers The maximum number of build workers used to run the build. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_performance.
  * @param offlineModeEnabled Whether the offline mode was set for the build. See https://docs.gradle.org/current/userguide/dynamic_versions.html#sec:offline-mode.
  * @param parallelProjectExecutionEnabled Whether parallel project execution was enabled for the build. See https://docs.gradle.org/current/userguide/multi_project_configuration_and_execution.html#sec:parallel_execution.
@@ -60,6 +61,10 @@
     @Json(name = "dryRunEnabled")
     val dryRunEnabled: kotlin.Boolean,
 
+    /* The list of excluded tasks. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:excluding_tasks_from_the_command_line. */
+    @Json(name = "excludedTasks")
+    val excludedTasks: kotlin.collections.List<kotlin.String>,
+
     /* The maximum number of build workers used to run the build. See https://docs.gradle.org/current/userguide/command_line_interface.html#sec:command_line_performance. */
     @Json(name = "maxNumberOfGradleWorkers")
     val maxNumberOfGradleWorkers: kotlin.Int,
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt	2023-06-29 05:42:29.327798969 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/MavenBuildCachePerformanceGoalExecutionEntry.kt	2023-06-29 05:42:11.043804631 +0000
@@ -32,6 +32,7 @@
  * @param avoidanceSavings The goal avoidance savings in milliseconds, which can be negative. Negative values indicate that it took more time to reuse outputs than it did to create them originally. May be `null` if the information was not available.
  * @param nonCacheabilityCategory The category of the non-cacheability reason:   * `build_cache_disabled_by_user` - The build cache was disabled by the user   * `goal_execution_marked_non_cacheable` - The goal execution was marked as non-cacheable   * `goal_not_supported` - The goal did not support build caching   * `no_gradle_enterprise_server_configured` - No Gradle Enterprise server was configured   * `non_clean_build` - The `clean` lifecycle was not executed    * `not_entitled` - The Gradle Enterprise license entitlements did not allow Maven build caching   * `offline_build` - The build was run in offline mode   * `unknown` - Reason for disabled caching was not known   * `unknown_entitlements` - The Gradle Enterprise license entitlements could not be checked  May be `null` when the goal execution was cacheable or if the information was not available. 
  * @param nonCacheabilityReason The human-readable reason for a non-cacheable goal execution. May be `null` when the goal execution was cacheable or if the information was not available.
+ * @param cacheArtifactSize The number of bytes of the produced or consumed cache artifact. For a goal execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a goal execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the goal execution is not cacheable, or if the attempt to store or load the artifact from cache did not succeed. 
  */
 
 
@@ -75,7 +76,11 @@
 
     /* The human-readable reason for a non-cacheable goal execution. May be `null` when the goal execution was cacheable or if the information was not available. */
     @Json(name = "nonCacheabilityReason")
-    val nonCacheabilityReason: kotlin.String? = null
+    val nonCacheabilityReason: kotlin.String? = null,
+
+    /* The number of bytes of the produced or consumed cache artifact. For a goal execution where the outputs were successfully stored to a local or remote cache, this will be the size of the stored cache artifact. For a goal execution where the outputs were successfully loaded from a local or remote cache, this will be the size of the loaded cache artifact. The value will be `null` if the goal execution is not cacheable, or if the attempt to store or load the artifact from cache did not succeed.  */
+    @Json(name = "cacheArtifactSize")
+    val cacheArtifactSize: kotlin.Long? = null
 
 ) {
 
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKey.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKey.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKey.kt	2023-06-29 05:42:29.479798937 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKey.kt	2023-06-29 05:42:11.199804571 +0000
@@ -23,6 +23,7 @@
  * A Test Distribution Agent API key.
  *
  * @param key The Agent API key.
+ * @param description Description of the API key, such as the agent pool where it will be used, to help identify it later.
  */
 
 
@@ -30,7 +31,11 @@
 
     /* The Agent API key. */
     @Json(name = "key")
-    val key: kotlin.String
+    val key: kotlin.String,
+
+    /* Description of the API key, such as the agent pool where it will be used, to help identify it later. */
+    @Json(name = "description")
+    val description: kotlin.String? = null
 
 )
 
Only in ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model: TestDistributionApiKeyDescription.kt
diff -ur ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt
--- ./base-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt	2023-06-29 05:42:29.491798934 +0000
+++ ./pr-ref-api/src/main/kotlin/com/gabrielfeo/gradle/enterprise/api/model/TestDistributionApiKeyPrefix.kt	2023-06-29 05:42:11.223804561 +0000
@@ -24,7 +24,9 @@
  *
  * @param keyPrefix The Agent API key.
  * @param generatedAt 
+ * @param description Description of the API key, such as the agent pool where it will be used, to help identify it later.
  * @param lastUsedAt 
+ * @param lastUsedBy 
  * @param revokedAt 
  */
 
@@ -38,9 +40,16 @@
     @Json(name = "generatedAt")
     val generatedAt: java.time.OffsetDateTime,
 
+    /* Description of the API key, such as the agent pool where it will be used, to help identify it later. */
+    @Json(name = "description")
+    val description: kotlin.String? = null,
+
     @Json(name = "lastUsedAt")
     val lastUsedAt: java.time.OffsetDateTime? = null,
 
+    @Json(name = "lastUsedBy")
+    val lastUsedBy: kotlin.String? = null,
+
     @Json(name = "revokedAt")
     val revokedAt: java.time.OffsetDateTime? = null
 

@github-actions github-actions bot force-pushed the feature/api-spec-2023.1 branch from 7a262ce to 049e2c7 Compare April 24, 2023 06:12
@gabrielfeo gabrielfeo force-pushed the feature/api-spec-2023.1 branch from 049e2c7 to ad54b51 Compare April 24, 2023 11:16
@github-actions github-actions bot force-pushed the feature/api-spec-2023.1 branch from ad54b51 to 6b91012 Compare May 1, 2023 06:12
@github-actions github-actions bot force-pushed the feature/api-spec-2023.1 branch 3 times, most recently from 6b0ed03 to 1f310d7 Compare May 20, 2023 06:08
@github-actions github-actions bot force-pushed the feature/api-spec-2023.1 branch 4 times, most recently from 8dbd769 to 81452fc Compare May 26, 2023 06:09
@gabrielfeo gabrielfeo force-pushed the feature/api-spec-2023.1 branch from fc6a6d8 to 7781138 Compare June 29, 2023 05:39
@gabrielfeo gabrielfeo merged commit 3052465 into main Jun 29, 2023
@gabrielfeo gabrielfeo deleted the feature/api-spec-2023.1 branch June 29, 2023 05:46
@gabrielfeo gabrielfeo restored the feature/api-spec-2023.1 branch November 30, 2024 02:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant