@salesforce/lds-adapters-platform-devworkspace 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,176 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '64.0'
+mediaType: application/json
+protocols:
+  - https
+baseUri: /services/data/v66.0
+securitySchemes:
+  OAuth2:
+    type: OAuth 2.0
+    settings:
+      authorizationUri: https://example.com/oauth/authorize
+      accessTokenUri: ''
+      authorizationGrants:
+        - implicit
+annotationTypes:
+  oas-readOnly:
+    type: boolean
+    allowedTargets: TypeDeclaration
+  oas-collectionFormat:
+    type: string
+  oas-body-name:
+    type: string
+    allowedTargets: TypeDeclaration
+types:
+  DevWorkspaceDetailsCollectionRepresentation:
+    description: Representation for Dev Workspace Item list
+    type: object
+    properties:
+      count:
+        description: Returns the count of all Salesforce Apps
+        type: integer
+      devWorkspaces:
+        description: Returns the list of all Dev Workspaces
+        type: array
+        items:
+          type: DevWorkspaceDetailsRepresentation
+  DevWorkspaceDetailsRepresentation:
+    description: Representation for Dev Workspace
+    type: object
+    properties:
+      description:
+        description: The description of Dev Workspace
+        type: string
+        required: false
+      devWorkspaceId:
+        description: The id of Dev Workspace
+        type: string
+      developerName:
+        description: The developerName of DevWorkspace
+        type: string
+      lastModifiedDate:
+        description: The lastModifiedDate for Dev Workspace
+        type: string
+      masterLabel:
+        description: The masterLabel of Dev Workspace
+        type: string
+      activePlan:
+        description: The Plan ID for active plan for the Dev Workspace
+        type: string
+        required: false
+  DevWorkspaceMetadataCollectionOutputRepresentation:
+    description: Representation for list of Workspace Metadata
+    type: object
+    properties:
+      currentDevWorkspaceId:
+        description: The ID of current workspace whose metadata is returned
+        type: string
+      devWorkspaceMetadata:
+        description: The list of metadata in a Workspace
+        type: array
+        items:
+          type: DevWorkspaceMetadataDetailOutputRepresentation
+  DevWorkspaceMetadataDetailOutputRepresentation:
+    description: Representation for DevWorkspace Metadata
+    type: object
+    properties:
+      actionURL:
+        description: The action url of the metadata record
+        type: string
+        required: false
+      developerName:
+        description: The developer name of the metadata record
+        type: string
+        required: false
+      label:
+        description: The label of the metadata record
+        type: string
+        required: false
+      lastModifiedDate:
+        description: The last modified date of the metadata record
+        type: string
+        required: false
+      metadataId:
+        description: The metadata id of the metadata record
+        type: string
+      metadataType:
+        description: The metadata type of the metadata record
+        type: string
+        required: false
+      metadataTypeLabel:
+        description: The label of the metadata type
+        type: string
+        required: false
+      isAiGenerated:
+        description: Whether the metadata was generated through AI
+        type: boolean
+        required: false
+  DevWorkspaceMetadataIdCollectionInputRepresentation:
+    description: Representation for List of metadata Ids
+    type: object
+    properties:
+      metadataIds:
+        description: The list of ids of metadata
+        type: array
+        items:
+          type: string
+      operationType:
+        description: The list of ids of metadata
+        type: string
+        enum:
+          - AddMetadata
+          - RemoveMetadata
+/connect/workspaces:
+  get:
+    displayName: getDevWorkspaces
+    description: Get all Dev Workspaces for a user
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: DevWorkspaceDetailsCollectionRepresentation
+/connect/workspaces/{devWorkspaceId}:
+  get:
+    displayName: getDevWorkspace
+    description: Gets Details of a Dev Workspace
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: DevWorkspaceDetailsRepresentation
+  uriParameters:
+    devWorkspaceId:
+      type: string
+      required: true
+/connect/workspaces/{devWorkspaceId}/metadata:
+  get:
+    displayName: getDevWorkspacesMetadata
+    description: Gets all metadata associated with a DevWorkspace
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: DevWorkspaceMetadataCollectionOutputRepresentation
+  patch:
+    displayName: patchDevWorkspacesMetadata
+    description: Adds or removes metadata to a DevWorkspace based on operationType
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: DevWorkspaceMetadataCollectionOutputRepresentation
+    body:
+      application/json:
+        type: DevWorkspaceMetadataIdCollectionInputRepresentation
+        (oas-body-name): updateMetadataInput
+  uriParameters:
+    devWorkspaceId:
+      type: string
+      required: true

package/src/raml/luvio.raml

@@ -0,0 +1,43 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'DevWorkspace'
+
+types:
+  DevWorkspaceMetadataCollectionOutputRepresentation:
+    (luvio.ttl): 30000
+    (luvio.key):
+      workspaceId: currentDevWorkspaceId
+    (luvio.opaque): true
+  DevWorkspaceMetadataDetailOutputRepresentation:
+    (luvio.ttl): 30000
+    (luvio.opaque): true
+  DevWorkspaceDetailsCollectionRepresentation:
+    (luvio.ttl): 30000
+    (luvio.opaque): true
+  DevWorkspaceDetailsRepresentation:
+    (luvio.ttl): 30000
+    (luvio.opaque): true
+
+/connect/workspaces/{devWorkspaceId}/metadata:
+  get:
+    (luvio.adapter):
+      name: getDevWorkspaceMetadata
+    (luvio.key):
+      workspaceId: urlParams.devWorkspaceId
+  patch:
+    (luvio.adapter):
+      name: updateDevWorkspaceMetadata
+
+/connect/workspaces/{devWorkspaceId}:
+  get:
+    (luvio.adapter):
+      name: getDevWorkspaceDetails
+
+/connect/workspaces:
+  get:
+    (luvio.adapter):
+      name: getDevWorkspaces