Add source type to SourceDefinitionRead (#14967)

airbytehq · Jul 25, 2022 · 4910f25 · 4910f25
1 parent fa3eb5f
commit 4910f25
Show file tree

Hide file tree

Showing 3 changed files with 35 additions and 0 deletions.
diff --git a/airbyte-api/src/main/openapi/config.yaml b/airbyte-api/src/main/openapi/config.yaml
@@ -2584,6 +2584,13 @@ components:
           description: The date when this connector was first released, in yyyy-mm-dd format.
           type: string
           format: date
+        sourceType:
+          type: string
+          enum:
+            - api
+            - file
+            - database
+            - custom
         resourceRequirements:
           $ref: "#/components/schemas/ActorDefinitionResourceRequirements"
     SourceDefinitionReadList:

diff --git a/airbyte-server/src/main/java/io/airbyte/server/handlers/SourceDefinitionsHandler.java b/airbyte-server/src/main/java/io/airbyte/server/handlers/SourceDefinitionsHandler.java
@@ -16,6 +16,7 @@
 import io.airbyte.api.model.generated.SourceDefinitionIdRequestBody;
 import io.airbyte.api.model.generated.SourceDefinitionIdWithWorkspaceId;
 import io.airbyte.api.model.generated.SourceDefinitionRead;
+import io.airbyte.api.model.generated.SourceDefinitionRead.SourceTypeEnum;
 import io.airbyte.api.model.generated.SourceDefinitionReadList;
 import io.airbyte.api.model.generated.SourceDefinitionUpdate;
 import io.airbyte.api.model.generated.SourceRead;
@@ -78,6 +79,7 @@ static SourceDefinitionRead buildSourceDefinitionRead(final StandardSourceDefini
       return new SourceDefinitionRead()
           .sourceDefinitionId(standardSourceDefinition.getSourceDefinitionId())
           .name(standardSourceDefinition.getName())
+          .sourceType(getSourceType(standardSourceDefinition))
           .dockerRepository(standardSourceDefinition.getDockerRepository())
           .dockerImageTag(standardSourceDefinition.getDockerImageTag())
           .documentationUrl(new URI(standardSourceDefinition.getDocumentationUrl()))
@@ -91,6 +93,13 @@ static SourceDefinitionRead buildSourceDefinitionRead(final StandardSourceDefini
     }
   }
 
+  private static SourceTypeEnum getSourceType(final StandardSourceDefinition standardSourceDefinition) {
+    if (standardSourceDefinition.getSourceType() == null) {
+      return null;
+    }
+    return SourceTypeEnum.fromValue(standardSourceDefinition.getSourceType().value());
+  }
+
   private static ReleaseStage getReleaseStage(final StandardSourceDefinition standardSourceDefinition) {
     if (standardSourceDefinition.getReleaseStage() == null) {
       return null;

diff --git a/docs/reference/api/generated-api-html/index.html b/docs/reference/api/generated-api-html/index.html
@@ -4266,6 +4266,7 @@ <h3 class="field-label">Example data</h3>
       "documentationUrl" : "https://openapi-generator.tech",
       "dockerImageTag" : "dockerImageTag",
       "releaseDate" : "2000-01-23",
+      "sourceType" : "api",
       "dockerRepository" : "dockerRepository",
       "name" : "name",
       "icon" : "icon",
@@ -6739,6 +6740,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -6823,6 +6825,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -7003,6 +7006,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -7090,6 +7094,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -7178,6 +7183,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7256,6 +7262,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7287,6 +7294,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7371,6 +7379,7 @@ <h3 class="field-label">Example data</h3>
       "documentationUrl" : "https://openapi-generator.tech",
       "dockerImageTag" : "dockerImageTag",
       "releaseDate" : "2000-01-23",
+      "sourceType" : "api",
       "dockerRepository" : "dockerRepository",
       "name" : "name",
       "icon" : "icon",
@@ -7405,6 +7414,7 @@ <h3 class="field-label">Example data</h3>
       "documentationUrl" : "https://openapi-generator.tech",
       "dockerImageTag" : "dockerImageTag",
       "releaseDate" : "2000-01-23",
+      "sourceType" : "api",
       "dockerRepository" : "dockerRepository",
       "name" : "name",
       "icon" : "icon",
@@ -7478,6 +7488,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7509,6 +7520,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7592,6 +7604,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7623,6 +7636,7 @@ <h3 class="field-label">Example data</h3>
     "documentationUrl" : "https://openapi-generator.tech",
     "dockerImageTag" : "dockerImageTag",
     "releaseDate" : "2000-01-23",
+    "sourceType" : "api",
     "dockerRepository" : "dockerRepository",
     "name" : "name",
     "icon" : "icon",
@@ -7753,6 +7767,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -7840,6 +7855,7 @@ <h3 class="field-label">Example data</h3>
   "documentationUrl" : "https://openapi-generator.tech",
   "dockerImageTag" : "dockerImageTag",
   "releaseDate" : "2000-01-23",
+  "sourceType" : "api",
   "dockerRepository" : "dockerRepository",
   "name" : "name",
   "icon" : "icon",
@@ -11730,6 +11746,9 @@ <h3><a name="SourceDefinitionRead"><code>SourceDefinitionRead</code> - </a> <a c
 <div class="param">icon (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
 <div class="param">releaseStage (optional)</div><div class="param-desc"><span class="param-type"><a href="#ReleaseStage">ReleaseStage</a></span>  </div>
 <div class="param">releaseDate (optional)</div><div class="param-desc"><span class="param-type"><a href="#date">date</a></span> The date when this connector was first released, in yyyy-mm-dd format. format: date</div>
+<div class="param">sourceType (optional)</div><div class="param-desc"><span class="param-type"><a href="#string">String</a></span>  </div>
+        <div class="param-enum-header">Enum:</div>
+        <div class="param-enum">api</div><div class="param-enum">file</div><div class="param-enum">database</div><div class="param-enum">custom</div>
 <div class="param">resourceRequirements (optional)</div><div class="param-desc"><span class="param-type"><a href="#ActorDefinitionResourceRequirements">ActorDefinitionResourceRequirements</a></span>  </div>
     </div>  <!-- field-items -->
   </div>