Documentation and schema improvements

.fern/metadata.json

@@ -10,9 +10,9 @@
     ],
     "retry-status-codes": "legacy"
   },
-  "originGitCommit": "fa2fad94474bee68b5a4c87f25775ff6701a0fe6",
+  "originGitCommit": "0154aca6f568afe2b2c183a43a8454aa86412754",
   "originGitCommitIsDirty": false,
   "invokedBy": "ci",
   "ciProvider": "github",
-  "sdkVersion": "2.0.4"
+  "sdkVersion": "2.0.5"
 }

README.md

@@ -30,7 +30,7 @@ Add the dependency in your `build.gradle` file:
 
 ```groovy
 dependencies {
-  implementation 'com.pipedream:pipedream:2.0.4'
+  implementation 'com.pipedream:pipedream:2.0.5'
 }
 ```
 
@@ -42,7 +42,7 @@ Add the dependency in your `pom.xml` file:
 <dependency>
   <groupId>com.pipedream</groupId>
   <artifactId>pipedream</artifactId>
-  <version>2.0.4</version>
+  <version>2.0.5</version>
 </dependency>
 ```
 

build.gradle

@@ -48,7 +48,7 @@ java {
 
 group = 'com.pipedream'
 
-version = '2.0.4'
+version = '2.0.5'
 
 jar {
     dependsOn(":generatePomFileForMavenPublication")
@@ -79,7 +79,7 @@ publishing {
         maven(MavenPublication) {
             groupId = 'com.pipedream'
             artifactId = 'pipedream'
-            version = '2.0.4'
+            version = '2.0.5'
             from components.java
             pom {
                 name = 'pipedream'

src/main/java/com/pipedream/api/core/ClientOptions.java

@@ -41,10 +41,10 @@ private ClientOptions(
         this.headers.putAll(headers);
         this.headers.putAll(new HashMap<String, String>() {
             {
-                put("User-Agent", "com.pipedream:pipedream/2.0.4");
+                put("User-Agent", "com.pipedream:pipedream/2.0.5");
                 put("X-Fern-Language", "JAVA");
                 put("X-Fern-SDK-Name", "com.pipedream.fern:api-sdk");
-                put("X-Fern-SDK-Version", "2.0.4");
+                put("X-Fern-SDK-Version", "2.0.5");
             }
         });
         this.headerSuppliers = headerSuppliers;

src/main/java/com/pipedream/api/resources/actions/requests/ActionsListRequest.java

@@ -93,7 +93,7 @@ public Optional<String> getApp() {
     }
 
     /**
-     * @return The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all')
+     * @return The registry to retrieve actions from
      */
     @JsonProperty("registry")
     public Optional<ActionsListRequestRegistry> getRegistry() {
@@ -234,7 +234,7 @@ public Builder app(String app) {
         }
 
         /**
-         * <p>The registry to retrieve actions from. Defaults to 'all' ('public', 'private', or 'all')</p>
+         * <p>The registry to retrieve actions from</p>
          */
         @JsonSetter(value = "registry", nulls = Nulls.SKIP)
         public Builder registry(Optional<ActionsListRequestRegistry> registry) {

src/main/java/com/pipedream/api/resources/actions/requests/ActionsRetrieveRequest.java

@@ -30,7 +30,7 @@ private ActionsRetrieveRequest(Optional<String> version, Map<String, Object> add
     }
 
     /**
-     * @return Optional semantic version of the component to retrieve (for example '1.0.0')
+     * @return Optional semantic version of the component to retrieve
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -81,7 +81,7 @@ public Builder from(ActionsRetrieveRequest other) {
         }
 
         /**
-         * <p>Optional semantic version of the component to retrieve (for example '1.0.0')</p>
+         * <p>Optional semantic version of the component to retrieve</p>
          */
         @JsonSetter(value = "version", nulls = Nulls.SKIP)
         public Builder version(Optional<String> version) {

src/main/java/com/pipedream/api/resources/actions/requests/RunActionOpts.java

@@ -63,7 +63,7 @@ public String getId() {
     }
 
     /**
-     * @return Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest
+     * @return Action component semantic version
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -155,7 +155,7 @@ public interface _FinalStage {
         _FinalStage additionalProperties(Map<String, Object> additionalProperties);
 
         /**
-         * <p>Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Action component semantic version</p>
          */
         _FinalStage version(Optional<String> version);
 
@@ -278,7 +278,7 @@ public _FinalStage configuredProps(Optional<Map<String, ConfiguredPropValue>> co
         }
 
         /**
-         * <p>Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Action component semantic version</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override
@@ -288,7 +288,7 @@ public _FinalStage version(String version) {
         }
 
         /**
-         * <p>Optional action component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Action component semantic version</p>
          */
         @java.lang.Override
         @JsonSetter(value = "version", nulls = Nulls.SKIP)

src/main/java/com/pipedream/api/resources/components/requests/ComponentsListRequest.java

@@ -98,7 +98,7 @@ public Optional<String> getApp() {
     }
 
     /**
-     * @return The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all')
+     * @return The registry to retrieve components from
      */
     @JsonProperty("registry")
     public Optional<ComponentsListRequestRegistry> getRegistry() {
@@ -251,7 +251,7 @@ public Builder app(String app) {
         }
 
         /**
-         * <p>The registry to retrieve components from. Defaults to 'all' ('public', 'private', or 'all')</p>
+         * <p>The registry to retrieve components from</p>
          */
         @JsonSetter(value = "registry", nulls = Nulls.SKIP)
         public Builder registry(Optional<ComponentsListRequestRegistry> registry) {

src/main/java/com/pipedream/api/resources/components/requests/ComponentsRetrieveRequest.java

@@ -30,7 +30,7 @@ private ComponentsRetrieveRequest(Optional<String> version, Map<String, Object>
     }
 
     /**
-     * @return Optional semantic version of the component to retrieve (for example '1.0.0')
+     * @return Optional semantic version of the component to retrieve
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -81,7 +81,7 @@ public Builder from(ComponentsRetrieveRequest other) {
         }
 
         /**
-         * <p>Optional semantic version of the component to retrieve (for example '1.0.0')</p>
+         * <p>Optional semantic version of the component to retrieve</p>
          */
         @JsonSetter(value = "version", nulls = Nulls.SKIP)
         public Builder version(Optional<String> version) {

src/main/java/com/pipedream/api/resources/triggers/requests/DeployTriggerOpts.java

@@ -70,7 +70,7 @@ public String getId() {
     }
 
     /**
-     * @return Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest
+     * @return Trigger component semantic version
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -190,7 +190,7 @@ public interface _FinalStage {
         _FinalStage additionalProperties(Map<String, Object> additionalProperties);
 
         /**
-         * <p>Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Trigger component semantic version</p>
          */
         _FinalStage version(Optional<String> version);
 
@@ -383,7 +383,7 @@ public _FinalStage configuredProps(Optional<Map<String, ConfiguredPropValue>> co
         }
 
         /**
-         * <p>Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Trigger component semantic version</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override
@@ -393,7 +393,7 @@ public _FinalStage version(String version) {
         }
 
         /**
-         * <p>Optional trigger component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Trigger component semantic version</p>
          */
         @java.lang.Override
         @JsonSetter(value = "version", nulls = Nulls.SKIP)

src/main/java/com/pipedream/api/resources/triggers/requests/TriggersListRequest.java

@@ -93,7 +93,7 @@ public Optional<String> getApp() {
     }
 
     /**
-     * @return The registry to retrieve triggers from. Defaults to 'all' ('public', 'private', or 'all')
+     * @return The registry to retrieve triggers from
      */
     @JsonProperty("registry")
     public Optional<TriggersListRequestRegistry> getRegistry() {
@@ -234,7 +234,7 @@ public Builder app(String app) {
         }
 
         /**
-         * <p>The registry to retrieve triggers from. Defaults to 'all' ('public', 'private', or 'all')</p>
+         * <p>The registry to retrieve triggers from</p>
          */
         @JsonSetter(value = "registry", nulls = Nulls.SKIP)
         public Builder registry(Optional<TriggersListRequestRegistry> registry) {

src/main/java/com/pipedream/api/resources/triggers/requests/TriggersRetrieveRequest.java

@@ -30,7 +30,7 @@ private TriggersRetrieveRequest(Optional<String> version, Map<String, Object> ad
     }
 
     /**
-     * @return Optional semantic version of the component to retrieve (for example '1.0.0')
+     * @return Optional semantic version of the component to retrieve
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -81,7 +81,7 @@ public Builder from(TriggersRetrieveRequest other) {
         }
 
         /**
-         * <p>Optional semantic version of the component to retrieve (for example '1.0.0')</p>
+         * <p>Optional semantic version of the component to retrieve</p>
          */
         @JsonSetter(value = "version", nulls = Nulls.SKIP)
         public Builder version(Optional<String> version) {

src/main/java/com/pipedream/api/types/Component.java

@@ -71,15 +71,15 @@ public String getKey() {
     }
 
     /**
-     * @return The human-readable name of the component, e.g. 'GitLab: List Commits'
+     * @return The human-readable name of the component
      */
     @JsonProperty("name")
     public String getName() {
         return name;
     }
 
     /**
-     * @return The latest version of the component, in SemVer format.
+     * @return The latest version of the component, in semantic versioning format.
      */
     @JsonProperty("version")
     public String getVersion() {
@@ -172,14 +172,14 @@ public interface KeyStage {
 
     public interface NameStage {
         /**
-         * <p>The human-readable name of the component, e.g. 'GitLab: List Commits'</p>
+         * <p>The human-readable name of the component</p>
          */
         VersionStage name(@NotNull String name);
     }
 
     public interface VersionStage {
         /**
-         * <p>The latest version of the component, in SemVer format.</p>
+         * <p>The latest version of the component, in semantic versioning format.</p>
          */
         _FinalStage version(@NotNull String version);
     }
@@ -269,8 +269,8 @@ public NameStage key(@NotNull String key) {
         }
 
         /**
-         * <p>The human-readable name of the component, e.g. 'GitLab: List Commits'</p>
-         * <p>The human-readable name of the component, e.g. 'GitLab: List Commits'</p>
+         * <p>The human-readable name of the component</p>
+         * <p>The human-readable name of the component</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override
@@ -281,8 +281,8 @@ public VersionStage name(@NotNull String name) {
         }
 
         /**
-         * <p>The latest version of the component, in SemVer format.</p>
-         * <p>The latest version of the component, in SemVer format.</p>
+         * <p>The latest version of the component, in semantic versioning format.</p>
+         * <p>The latest version of the component, in semantic versioning format.</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override

src/main/java/com/pipedream/api/types/ConfigurablePropApp.java

@@ -83,7 +83,7 @@ public String getType() {
     }
 
     /**
-     * @return The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured.
+     * @return The name slug of the app, used to identify the app for which the account is being configured.
      */
     @JsonProperty("app")
     public String getApp() {
@@ -232,7 +232,7 @@ public static AppStage builder() {
 
     public interface AppStage {
         /**
-         * <p>The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured.</p>
+         * <p>The name slug of the app, used to identify the app for which the account is being configured.</p>
          */
         NameStage app(@NotNull String app);
 
@@ -373,8 +373,8 @@ public Builder from(ConfigurablePropApp other) {
         }
 
         /**
-         * <p>The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured.</p>
-         * <p>The name slug of the app, e.g. 'github', 'slack', etc. This is used to identify the app for which the account is being configured.</p>
+         * <p>The name slug of the app, used to identify the app for which the account is being configured.</p>
+         * <p>The name slug of the app, used to identify the app for which the account is being configured.</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override

src/main/java/com/pipedream/api/types/ConfigurePropOpts.java

@@ -77,7 +77,7 @@ public String getId() {
     }
 
     /**
-     * @return Optional component version (in SemVer format, for example '1.0.0'), defaults to latest
+     * @return Component semantic version
      */
     @JsonProperty("version")
     public Optional<String> getVersion() {
@@ -224,7 +224,7 @@ public interface _FinalStage {
         _FinalStage additionalProperties(Map<String, Object> additionalProperties);
 
         /**
-         * <p>Optional component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Component semantic version</p>
          */
         _FinalStage version(Optional<String> version);
 
@@ -462,7 +462,7 @@ public _FinalStage blocking(Optional<Boolean> blocking) {
         }
 
         /**
-         * <p>Optional component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Component semantic version</p>
          * @return Reference to {@code this} so that method calls can be chained together.
          */
         @java.lang.Override
@@ -472,7 +472,7 @@ public _FinalStage version(String version) {
         }
 
         /**
-         * <p>Optional component version (in SemVer format, for example '1.0.0'), defaults to latest</p>
+         * <p>Component semantic version</p>
          */
         @java.lang.Override
         @JsonSetter(value = "version", nulls = Nulls.SKIP)