@salesforce/lds-adapters-platform-content-taxonomy 0.1.0-dev1

package/src/raml/api.raml

@@ -0,0 +1,267 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '60.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:
+  ContentTaxonomyPathFragmentRepresentation:
+    description: A fragment of a path in a content taxonomy, representing information
+      about a term or the taxonomy.
+    type: object
+    properties:
+      id:
+        description: The ID of the term or the taxonomy.
+        type: string
+      label:
+        description: The label of the term or the taxonomy.
+        type: string
+  ContentTaxonomyPathRepresentation:
+    description: A path to a term in a content taxonomy.
+    type: object
+    properties:
+      label:
+        description: A text representation of the path from the root, joined with
+          a delimiter.
+        type: string
+      taxonomyFragment:
+        description: A path fragment representing the taxonomy.
+        type: ContentTaxonomyPathFragmentRepresentation
+      termFragments:
+        description: Path fragments representing the terms from root term to this
+          term, inclusive.
+        type: array
+        items:
+          type: ContentTaxonomyPathFragmentRepresentation
+  ContentTaxonomyTermCollectionRepresentation:
+    description: A collection of content taxonomy terms.
+    type: object
+    properties:
+      currentPageUrl:
+        description: The URL for the current page of taxonomy terms.
+        type: string
+      nextPageUrl:
+        description: The URL for the next page of taxonomy terms.
+        type: string
+      terms:
+        description: The list of taxonomy terms in this page.
+        type: array
+        items:
+          type: ContentTaxonomyTermRepresentation
+  ContentTaxonomyTermInputRepresentation:
+    description: Input for creating or updating a content taxonomy term.
+    type: object
+    properties:
+      description:
+        description: The description of the term, which may be left empty. When updating
+          a term, set to null to clear the description.
+        type: string | nil
+        required: false
+      label:
+        description: The label of the term to create or, when updating, a new label for
+          an existing term.
+        type: string
+      parentTermId:
+        description: When creating a term, the parent term ID of the term to create;
+          set to null or leave empty to create a root term. When updating a term, the new
+          parent term ID for the existing term; set to null to make a child term into a root term.
+        type: string | nil
+        required: false
+  ContentTaxonomyTermRepresentation:
+    description: A content taxonomy term.
+    type: object
+    properties:
+      childTerms:
+        description: The child terms of this term.
+        type: array
+        items:
+          type: ContentTaxonomyTermRepresentation
+      createdBy:
+        description: The user that created the term.
+        type: ContentTaxonomyUserSummary | nil
+      createdDate:
+        description: The date the term was created.
+        type: string | nil
+      description:
+        description: The description of the term.
+        type: string | nil
+      id:
+        description: The ID of the term.
+        type: string
+      isLeafTerm:
+        description: True if term has no children.
+        type: boolean | nil
+      label:
+        description: The label of the term.
+        type: string
+      lastModifiedBy:
+        description: The user that last modified the term.
+        type: ContentTaxonomyUserSummary | nil
+      lastModifiedDate:
+        description: The date the term was last modified.
+        type: string | nil
+      parentTerms:
+        description: The parent term(s) of this term.
+        type: array
+        items:
+          type: ContentTaxonomyTermRepresentation
+      pathsFromRoot:
+        description: The path(s) from a root term to this term.
+        type: array
+        items:
+          type: ContentTaxonomyPathRepresentation
+  ContentTaxonomyUserSummary:
+    description: Information about a user related to a content taxonomy or its terms.
+    type: object
+    properties:
+      id:
+        description: The ID of the user.
+        type: string
+      name:
+        description: The name of the user.
+        type: string
+      url:
+        description: The Connect API resource URL for the user.
+        type: string | nil
+/connect/content-taxonomy:
+  /terms:
+    get:
+      displayName: getContentTaxonomyTermCollection
+      description: Get multiple taxonomy terms.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContentTaxonomyTermCollectionRepresentation
+      queryParameters:
+        depth:
+          type: integer
+          required: false
+        includeMetadata:
+          type: boolean
+          required: false
+        includePaths:
+          type: boolean
+          required: false
+        initialTerms:
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+        taxonomyId:
+          type: string
+          required: true # Hand-rolled, connect framework does not support declaring query params as required.
+  /terms/search:
+    get:
+      displayName: getContentTaxonomyTermSearch
+      description: Search for matching taxonomy terms.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContentTaxonomyTermCollectionRepresentation
+      queryParameters:
+        includeMetadata:
+          type: boolean
+          required: false
+        page:
+          type: integer
+          required: false
+        pageSize:
+          type: integer
+          required: false
+        queryText:
+          type: string
+          required: false
+        taxonomyIds:
+          type: array
+          required: false
+          items:
+            type: string
+            (oas-collectionFormat): csv
+  /{taxonomyId}/terms:
+    post:
+      displayName: postSingleContentTaxonomyTermCollection
+      description: Create a taxonomy term.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContentTaxonomyTermRepresentation
+      body:
+        application/json:
+          type: ContentTaxonomyTermInputRepresentation
+          # required: false - TODO - not supported on patch
+          (oas-body-name): term
+    uriParameters:
+      taxonomyId:
+        type: string
+        required: true
+  /{taxonomyId}/terms/{termId}:
+    delete:
+      displayName: deleteContentTaxonomyTerm
+      description: Delete a taxonomy term.
+      responses:
+        '200':
+          description: Success
+      queryParameters:
+        deleteChildren:
+          type: boolean
+          required: false
+        newParentTerm:
+          type: string
+          required: false
+    get:
+      displayName: getContentTaxonomyTerm
+      description: Get a taxonomy term.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContentTaxonomyTermRepresentation
+    patch:
+      displayName: patchContentTaxonomyTerm
+      description: Update a taxonomy term.
+      responses:
+        '200':
+          description: Success
+          body:
+            application/json:
+              type: ContentTaxonomyTermRepresentation
+      body:
+        application/json:
+          type: ContentTaxonomyTermInputRepresentation
+          # required: false - TODO - not supported on patch
+          (oas-body-name): term
+    uriParameters:
+      taxonomyId:
+        type: string
+        required: true
+      termId:
+        type: string
+        required: true

package/src/raml/luvio.raml

@@ -0,0 +1,57 @@
+#%RAML 1.0 Overlay
+extends: ./api.raml
+
+uses:
+  luvio: luvio://annotations.raml
+
+(luvio.keyPrefix): 'content-taxonomy'
+
+types:
+  ContentTaxonomyTermCollectionRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ContentTaxonomyTermRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+    (luvio.key):
+      id: id
+  ContentTaxonomyUserSummary:
+    (luvio.ttl): 10000
+    (luvio.key):
+      id: id
+  ContentTaxonomyPathRepresentation:
+    (luvio.ttl): 100
+    (luvio.opaque): true
+  ContentTaxonomyPathFragmentRepresentation:
+    (luvio.ttl): 100
+    (luvio.key):
+      id: id
+  ContentTaxonomyTermInputRepresentation:
+    (luvio.ttl): 100
+/connect/content-taxonomy:
+  /terms:
+    get:
+      (luvio.adapter):
+        name: getTerms
+  /terms/search:
+    get:
+      (luvio.adapter):
+        name: searchTerms
+  /{taxonomyId}/terms/{termId}:
+    delete:
+      (luvio.adapter):
+        name: deleteTerm
+      (luvio.key):
+        id: urlParams.termId
+    get:
+      (luvio.adapter):
+        name: getTerm
+      (luvio.key):
+        id: urlParams.termId
+    patch:
+      (luvio.adapter):
+        name: updateTerm
+  /{taxonomyId}/terms:
+    post:
+      (luvio.adapter):
+        name: createTerm