Integration endpoint improvements (#301)

- Add additional properties to integration definitions
- add meta parameter for inlining an integration definition into integration calls
- remove provider options endpoint

components/schemas/hubs/integrations/IntegrationDefinition.yml

@@ -5,8 +5,11 @@ required:
   - identifier
   - name
   - supports_verification
+  - supports_multiple
   - required_fields
   - url
+  - public
+  - usable
 properties:
   identifier:
     type: string
@@ -28,6 +31,29 @@ properties:
     type: boolean
   supports_multiple:
     type: boolean
+  features:
+    type: array
+    description: A list of additional features supported by this Integration.
+    nullable: true
+    items:
+      type: string
+  extended_configuration:
+    type: object
+    nullable: true
+    description: Additional configuration options that are available when using this Integration. These describe additional functionality that Cycle may utilize.
+    properties:
+      options:
+        type: array
+        nullable: true
+        items:
+          type: object
+          properties:
+            title:
+              type: string
+            key:
+              type: string
+            type:
+              type: string
   fields:
     type: object
     properties:
@@ -69,3 +95,6 @@ properties:
   public:
     type: boolean
     nullable: true
+  usable:
+    type: boolean
+    nullable: true

components/schemas/hubs/integrations/IntegrationMeta.yml

@@ -0,0 +1,7 @@
+title: IntegrationMeta
+type: object
+description: Additional fields that can be requested for an Integration on fetch.
+properties:
+  definition:
+    $ref: "../StateCountSummary.yml"
+    description: The full Integration definition associated with this Integration.

public/api.yml

@@ -330,8 +330,6 @@ paths:
   "/v1/infrastructure/summary":
     "$ref": "./paths/infrastructure/summary.yml"
   ## Providers
-  "/v1/infrastructure/providers/options":
-    "$ref": "./paths/infrastructure/providers/options.yml"
   "/v1/infrastructure/providers/{providerIdentifier}/servers":
     "$ref": "./paths/infrastructure/providers/servers.yml"
   "/v1/infrastructure/providers/{providerIdentifier}/locations":

public/paths/hubs/integrations/integration.yml

@@ -14,6 +14,21 @@ get:
         type: string
         pattern: "^[a-f0-9]{24}$"
       description: The ID of the integration to retrieve.
+    - name: meta
+      in: query
+      required: false
+      description:
+        A comma separated list of meta values. Meta values will show up under a resource's
+        `meta` field. In the case of applying a meta to a collection of resources, each
+        resource will have it's own relevant meta data. In some rare cases, meta may not
+        apply to individual resources, and may appear in the root document. These will be
+        clearly labeled.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - definition
   responses:
     200:
       description: Details of the specified integration
@@ -45,6 +60,21 @@ patch:
         type: string
         pattern: "^[a-f0-9]{24}$"
       description: The ID of the integration to update.
+    - name: meta
+      in: query
+      required: false
+      description:
+        A comma separated list of meta values. Meta values will show up under a resource's
+        `meta` field. In the case of applying a meta to a collection of resources, each
+        resource will have it's own relevant meta data. In some rare cases, meta may not
+        apply to individual resources, and may appear in the root document. These will be
+        clearly labeled.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - definition
   requestBody:
     required: true
     content:

public/paths/hubs/integrations/integrations.yml

@@ -8,6 +8,21 @@ get:
   description: Lists all integrations associated with the current hub, with optional filtering.
   parameters:
     - $ref: ../../../../components/parameters/PageParam.yml
+    - name: meta
+      in: query
+      required: false
+      description:
+        A comma separated list of meta values. Meta values will show up under a resource's
+        `meta` field. In the case of applying a meta to a collection of resources, each
+        resource will have it's own relevant meta data. In some rare cases, meta may not
+        apply to individual resources, and may appear in the root document. These will be
+        clearly labeled.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - definition
     - name: filter
       in: query
       style: deepObject
@@ -57,7 +72,22 @@ post:
     - Hubs
   security:
     - bearerAuth: []
-  parameters: []
+  parameters:
+    - name: meta
+      in: query
+      required: false
+      description:
+        A comma separated list of meta values. Meta values will show up under a resource's
+        `meta` field. In the case of applying a meta to a collection of resources, each
+        resource will have it's own relevant meta data. In some rare cases, meta may not
+        apply to individual resources, and may appear in the root document. These will be
+        clearly labeled.
+      schema:
+        type: array
+        items:
+          type: string
+          enum:
+            - definition
   summary: Create Integration
   description: Create an integration resource within a hub.
   requestBody: