Automated commit by github action: 10376213054

static/api-specs/idn/beta/paths/discovered-applications.yaml

@@ -11,6 +11,15 @@ get:
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
+    - in: query
+      name: detail
+      schema:
+        type: string
+        enum: [ SLIM, FULL ]
+      description: >-
+        Determines whether slim, or increased level of detail is provided for each discovered application in the returned list.
+        SLIM is the default behavior.
+      example: FULL
     - in: query
       name: filter
       schema:
@@ -26,7 +35,22 @@ get:
         
         
         **description**: *eq, sw, co*
-      example: name eq "Okta" and description co "Okta"
+        
+        
+        **createdAtStart**: *eq, le, ge*
+
+
+        **createdAtEnd**: *eq, le, ge*
+        
+        
+        **discoveredAtStart**: *eq, le, ge*
+        
+        
+        **discoveredAtEnd**: *eq, le, ge*
+
+
+        **discoverySource**: *eq, in*
+      example: name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")
       required: false
       style: form
     - in: query
@@ -42,13 +66,22 @@ get:
       example: name
   responses:
     '200':
-      description: Successfully retrieved list of discovered applications.
+      description: List of discovered applications. By default, the API returns a list of SLIM discovered applications.
       content:
         application/json:
           schema:
             type: array
             items:
-              $ref: '../../beta/schemas/DiscoveredApplications.yaml'
+              oneOf:
+                - $ref: '../schemas/SlimDiscoveredApplications.yaml'
+                - $ref: '../schemas/FullDiscoveredApplications.yaml'
+
+
+          examples:
+            Slim Discovered Application:
+              $ref: '../schemas/discovered-applications/examples/SlimDiscoveredApplications.yaml'
+            Discovered Application:
+              $ref: '../schemas/discovered-applications/examples/FullDiscoveredApplications.yaml'
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':

static/api-specs/idn/beta/schemas/FullDiscoveredApplications.yaml

@@ -0,0 +1,66 @@
+type: array
+description: List of discovered applications with their respective associated sources
+title: Discovered Application
+example:
+  - $ref: '../schemas/discovered-applications/examples/FullDiscoveredApplications.yaml'
+items:
+  type: object
+  properties:
+    id:
+      type: string
+      format: uuid
+      description: Unique identifier for the discovered application.
+      example: 2d9180835d2e5168015d32f890ca1581
+    name:
+      type: string
+      description: Name of the discovered application.
+      example: "ExampleApp"
+    discoverySource:
+      type: string
+      description: Source from which the application was discovered.
+      example: "csv"
+    discoveredVendor:
+      type: string
+      description: The vendor associated with the discovered application.
+      example: "ExampleVendor"
+    description:
+      type: string
+      description: A brief description of the discovered application.
+      example: "An application for managing examples."
+    recommendedConnectors:
+      type: array
+      items:
+        type: string
+      description: List of recommended connectors for the application.
+      example: ["ConnectorA", "ConnectorB"]
+    discoveredAt:
+      type: string
+      format: date-time
+      description: >-
+        The timestamp when the application was last received via an entitlement aggregation invocation 
+        or a manual csv upload, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    createdAt:
+      type: string
+      format: date-time
+      description: The timestamp when the application was first discovered, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    status:
+      type: string
+      description: >-
+        The status of an application within the discovery source.
+        
+        
+        By default this field is set to "ACTIVE" when the application is discovered.
+        
+        
+        If an application has been deleted from within the discovery source, the status will be
+        set to "INACTIVE".
+      example: "ACTIVE"
+    associatedSources:
+      type: array
+      items:
+        type: string
+        format: uuid
+      description: List of associated sources related to this discovered application.
+      example: [ "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923", "a0303682-5e4a-44f7-bdc2-6ce6112549c1" ]

static/api-specs/idn/beta/schemas/SlimDiscoveredApplications.yaml

@@ -0,0 +1,59 @@
+type: array
+description: List of discovered applications
+title: Slim Discovered Application
+example:
+  - $ref: '../schemas/discovered-applications/examples/SlimDiscoveredApplications.yaml'
+items:
+  type: object
+  properties:
+    id:
+      type: string
+      format: uuid
+      description: Unique identifier for the discovered application.
+      example: 2d9180835d2e5168015d32f890ca1581
+    name:
+      type: string
+      description: Name of the discovered application.
+      example: "ExampleApp"
+    discoverySource:
+      type: string
+      description: Source from which the application was discovered.
+      example: "csv"
+    discoveredVendor:
+      type: string
+      description: The vendor associated with the discovered application.
+      example: "ExampleVendor"
+    description:
+      type: string
+      description: A brief description of the discovered application.
+      example: "An application for managing examples."
+    recommendedConnectors:
+      type: array
+      items:
+        type: string
+      description: List of recommended connectors for the application.
+      example: ["ConnectorA", "ConnectorB"]
+    discoveredAt:
+      type: string
+      format: date-time
+      description: >-
+        The timestamp when the application was last received via an entitlement aggregation invocation 
+        or a manual csv upload, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    createdAt:
+      type: string
+      format: date-time
+      description: The timestamp when the application was first discovered, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    status:
+      type: string
+      description: >-
+        The status of an application within the discovery source.
+        
+        
+        By default this field is set to "ACTIVE" when the application is discovered.
+        
+        
+        If an application has been deleted from within the discovery source, the status will be
+        set to "INACTIVE".
+      example: "ACTIVE"

static/api-specs/idn/beta/schemas/discovered-applications/examples/FullDiscoveredApplications.yaml

@@ -0,0 +1,32 @@
+description: List of discovered applications with their respective associated sources
+value:
+  - id: "app-123"
+    name: "Example App"
+    discoverySource: "csv"
+    discoveredVendor: "Example Vendor"
+    description: "An application for managing examples."
+    recommendedConnectors: ["ConnectorA", "ConnectorB"]
+    discoveredAt: "2023-07-01T12:00:00Z"
+    createdAt: "2024-06-01T12:00:00Z"
+    status: "ACTIVE"
+    associatedSources: ["e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"]
+  - id: "app-456"
+    name: "Sample Tracker"
+    discoverySource: "Okta SaaS"
+    discoveredVendor: "Sample Vendor"
+    description: "A tool for monitoring and managing samples."
+    recommendedConnectors: ["ConnectorC", "ConnectorD"]
+    discoveredAt: "2023-08-15T08:00:00Z"
+    createdAt: "2024-05-20T08:00:00Z"
+    status: "ACTIVE"
+    associatedSources: ["a3b159f2-5f09-43c9-b40e-a6f317aa5b8f", "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923"]
+  - id: "app-789"
+    name: "Demo Manager"
+    discoverySource: "Okta SaaS"
+    discoveredVendor: "Demo Provider"
+    description: "Software to demonstrate basic functionalities."
+    recommendedConnectors: ["ConnectorE", "ConnectorF"]
+    discoveredAt: "2023-09-10T15:00:00Z"
+    createdAt: "2024-07-03T15:00:00Z"
+    status: "ACTIVE"
+    associatedSources: ["4e2d7605-833f-4c34-8d03-5b2c7d2f4f66", "f9b7e2ce-aced-4117-a95f-4ffad8b33989", "a3b159f2-5f09-43c9-b40e-a6f317aa5b8f"]

static/api-specs/idn/beta/schemas/discovered-applications/examples/SlimDiscoveredApplications.yaml

@@ -0,0 +1,29 @@
+description: List of discovered applications
+value:
+  - id: "app-123"
+    name: "Example App"
+    discoverySource: "csv"
+    discoveredVendor: "Example Vendor"
+    description: "An application for managing examples."
+    recommendedConnectors: ["ConnectorA", "ConnectorB"]
+    discoveredAt: "2023-07-01T12:00:00Z"
+    createdAt: "2024-06-01T12:00:00Z"
+    status: "ACTIVE"
+  - id: "app-456"
+    name: "Sample Tracker"
+    discoverySource: "Okta SaaS"
+    discoveredVendor: "Sample Vendor"
+    description: "A tool for monitoring and managing samples."
+    recommendedConnectors: ["ConnectorC", "ConnectorD"]
+    discoveredAt: "2023-08-15T08:00:00Z"
+    createdAt: "2024-05-20T08:00:00Z"
+    status: "ACTIVE"
+  - id: "app-789"
+    name: "Demo Manager"
+    discoverySource: "Okta SaaS"
+    discoveredVendor: "Demo Provider"
+    description: "Software to demonstrate basic functionalities."
+    recommendedConnectors: ["ConnectorE", "ConnectorF"]
+    discoveredAt: "2023-09-10T15:00:00Z"
+    createdAt: "2024-07-03T15:00:00Z"
+    status: "ACTIVE"

static/api-specs/idn/v3/paths/discovered-applications.yaml

@@ -11,6 +11,15 @@ get:
   parameters:
     - $ref: '../../v3/parameters/limit.yaml'
     - $ref: '../../v3/parameters/offset.yaml'
+    - in: query
+      name: detail
+      schema:
+        type: string
+        enum: [ SLIM, FULL ]
+      description: >-
+        Determines whether slim, or increased level of detail is provided for each discovered application in the returned list.
+        SLIM is the default behavior.
+      example: FULL
     - in: query
       name: filter
       schema:
@@ -26,7 +35,22 @@ get:
         
         
         **description**: *eq, sw, co*
-      example: name eq "Okta" and description co "Okta"
+        
+        
+        **createdAtStart**: *eq, le, ge*
+
+
+        **createdAtEnd**: *eq, le, ge*
+        
+        
+        **discoveredAtStart**: *eq, le, ge*
+        
+        
+        **discoveredAtEnd**: *eq, le, ge*
+
+
+        **discoverySource**: *eq, in*
+      example: name eq "Okta" and description co "Okta" and discoverySource in ("csv", "Okta Saas")
       required: false
       style: form
     - in: query
@@ -42,13 +66,22 @@ get:
       example: name
   responses:
     '200':
-      description: Successfully retrieved list of discovered applications.
+      description: List of discovered applications. By default, the API returns a list of SLIM discovered applications.
       content:
         application/json:
           schema:
             type: array
             items:
-              $ref: '../../beta/schemas/DiscoveredApplications.yaml'
+              oneOf:
+                - $ref: '../schemas/SlimDiscoveredApplications.yaml'
+                - $ref: '../schemas/FullDiscoveredApplications.yaml'
+
+
+          examples:
+            Slim Discovered Application:
+              $ref: '../schemas/discovered-applications/examples/SlimDiscoveredApplications.yaml'
+            Discovered Application:
+              $ref: '../schemas/discovered-applications/examples/FullDiscoveredApplications.yaml'
     '400':
       $ref: '../../v3/responses/400.yaml'
     '401':

static/api-specs/idn/v3/schemas/FullDiscoveredApplications.yaml

@@ -0,0 +1,66 @@
+type: array
+description: List of discovered applications with their respective associated sources
+title: Discovered Application
+example:
+  - $ref: '../schemas/discovered-applications/examples/FullDiscoveredApplications.yaml'
+items:
+  type: object
+  properties:
+    id:
+      type: string
+      format: uuid
+      description: Unique identifier for the discovered application.
+      example: 2d9180835d2e5168015d32f890ca1581
+    name:
+      type: string
+      description: Name of the discovered application.
+      example: "ExampleApp"
+    discoverySource:
+      type: string
+      description: Source from which the application was discovered.
+      example: "csv"
+    discoveredVendor:
+      type: string
+      description: The vendor associated with the discovered application.
+      example: "ExampleVendor"
+    description:
+      type: string
+      description: A brief description of the discovered application.
+      example: "An application for managing examples."
+    recommendedConnectors:
+      type: array
+      items:
+        type: string
+      description: List of recommended connectors for the application.
+      example: ["ConnectorA", "ConnectorB"]
+    discoveredAt:
+      type: string
+      format: date-time
+      description: >-
+        The timestamp when the application was last received via an entitlement aggregation invocation 
+        or a manual csv upload, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    createdAt:
+      type: string
+      format: date-time
+      description: The timestamp when the application was first discovered, in ISO 8601 format.
+      example: "2023-01-01T12:00:00Z"
+    status:
+      type: string
+      description: >-
+        The status of an application within the discovery source.
+        
+        
+        By default this field is set to "ACTIVE" when the application is discovered.
+        
+        
+        If an application has been deleted from within the discovery source, the status will be
+        set to "INACTIVE".
+      example: "ACTIVE"
+    associatedSources:
+      type: array
+      items:
+        type: string
+        format: uuid
+      description: List of associated sources related to this discovered application.
+      example: [ "e0cc5d7d-bf7f-4f81-b2af-8885b09d9923", "a0303682-5e4a-44f7-bdc2-6ce6112549c1" ]