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

package/src/raml/api.raml

@@ -0,0 +1,1011 @@
+#%RAML 1.0
+securedBy:
+  - OAuth2
+title: Salesforce Connect API
+version: '62.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:
+  ContentHubPermissionTypeRepresentation:
+    description: Description of a permission type.
+    type: object
+    properties:
+      id:
+        description: The internal id of the permission type in the external repository.
+        type: string
+      label:
+        description: The label as returned by the external repository.
+        type: string
+  ContentHubProviderTypeRepresentation:
+    description: Description of the type of a Content Hub repository.
+    type: object
+    properties:
+      label:
+        description: The provider type localized label.
+        type: string
+      type:
+        description: 'One of: ContentHubBox, ContentHubGDrive, ContentHubSharepointOffice365,
+          ContentHubSharepoint, ContentHubSharepointOneDrive, SimpleURL.'
+        type: string
+  ContentHubRepositoryAuthenticationRepresentation:
+    description: Authentication information related to a repository.
+    type: object
+    properties:
+      authFlowUrl:
+        description: "- When authentication protocol is OAuth, the URL to use to start
+          the OAuth flow- When authentication protocol is username/password, URL to
+          the 'Authentication Settings for External Systems' page- When authentication
+          protocol is anonymous, URL is null."
+        type: string
+      authProtocol:
+        description: Represents the authentication protocol used by the External Data
+          Source.
+        type: string
+        enum:
+          - NoAuthentication
+          - Oauth
+          - Password
+      userHasAuthSettings:
+        description: True only if the user has credentials created. If the XDS is
+          configured using 'Named Principal' identity type, true if the Admin has
+          authenticated using his/her credentials. False otherwise.
+        type: boolean
+  ContentHubRepositoryFeaturesRepresentation:
+    description: Description of the features of a Content Hub repository.
+    type: object
+    properties:
+      canBrowse:
+        description: Whether or not the Content Hub repository's folder hierarchy
+          can be browsed.
+        type: boolean
+      canSearch:
+        description: Whether or not the Content Hub repository can be searched.
+        type: boolean
+  ContentHubRepositoryRepresentation:
+    description: Description of a Content Hub repository.
+    type: object
+    properties:
+      authentication:
+        description: The repository authentication information.
+        type: ContentHubRepositoryAuthenticationRepresentation
+      features:
+        description: The repository features.
+        type: ContentHubRepositoryFeaturesRepresentation
+      label:
+        description: The repository label.
+        type: string
+      name:
+        description: The repository name.
+        type: string
+      providerType:
+        description: The repository provider type.
+        type: ContentHubProviderTypeRepresentation
+      rootFolderItemsUrl:
+        description: URL to the Connect resource for the list of items in the repository
+          root folder.
+        type: string
+      additionalLabel:
+        description: An additional label (if any) for the user, e.g. "Customer", "Partner",  or
+          "Acme Corporation".
+        type: string | nil
+      communityNickname:
+        description: Community Nickname.
+        type: string
+      companyName:
+        description: Name of the company.
+        type: string
+      displayName:
+        description: Display Name or Community Nickname.
+        type: string
+      firstName:
+        description: User's first name.
+        type: string
+      isInThisCommunity:
+        description: true if the user is in the community used in the request. false
+          otherwise.
+        type: boolean
+      lastName:
+        description: User's last name.
+        type: string
+      mySubscription:
+        description: If the logged-in user is following this user, this contains information
+          about the subscription, else returns null.
+        type: ReferenceRepresentation
+      title:
+        description: Title of the user.
+        type: string
+      userType:
+        description: 'Type of user. Valid values are: ChatterGuest—User is a Chatter
+          customer in an external group; Guest—Unauthenticated users; Internal—User
+          is a standard organization member Portal—User is a Customer Portal User,
+          a communities user, and so on; System—User is Chatter Expert or a system
+          user.'
+        type: string
+        enum:
+          - ChatterGuest
+          - ChatterOnly
+          - Guest
+          - Internal
+          - Portal
+          - System
+          - Undefined
+  ExternalFilePermissionInformationRepresentation:
+    description: External file permissions related information
+    type: object
+    properties:
+      externalFilePermissionTypes:
+        description: Available permissions types for the parent folder of the external
+          file, null for non external files or includeExternalFilePermissionsInfo
+          is false
+        type: array
+        items:
+          type: ContentHubPermissionTypeRepresentation
+      externalFilePermissionsFailure:
+        description: Whether or not external file information retrieval has failed,
+          if includeExternalFilePermissionsInfo is true, false otherwise
+        type: boolean
+      externalFilePermissionsInfoFailureReason:
+        description: Failure explanation, if includeExternalFilePermissionsInfo is
+          true and an exception was thrown during the external file permissions information
+          retrieval. Null otherwise
+        type: string
+      externalFileSharingStatus:
+        description: Current sharing status for the external file we’re creating a
+          reference on, null for non external files or includeExternalFilePermissionsInfo
+          is false
+        type: string
+        enum:
+          - DomainSharing
+          - PrivateSharing
+          - PublicSharing
+      repositoryPublicGroups:
+        description: Available groups such as “Everyone”/”Everyone in the domain”
+          in the external repository,  null for non external files or includeExternalFilePermissionsInfo
+          is false
+        type: array
+        items:
+          type: RepositoryGroupSummaryRepresentation
+  FileAssetRepresentation:
+    description: Representation of a file asset.
+    type: object
+    properties:
+      baseAssetUrl:
+        description: Base download URL of the asset.
+        type: string
+      baseUnauthenticatedAssetUrl:
+        description: Base unauthenticated download URL of the asset.
+        type: string
+      id:
+        description: The id of the asset
+        type: string
+      isVisibleByExternalUsers:
+        description: Flag for public access to asset.
+        type: boolean
+      masterLabel:
+        description: Master label of the asset.
+        type: string
+      name:
+        description: The unique name of the asset
+        type: string
+      namespacePrefix:
+        description: The namespacePrefix of the package containing the asset
+        type: string
+      type:
+        description: The type of this representation
+        type: string
+  FileInputRepresentation:
+    description: Describes a new file input. To upload a file, provide the binary
+      file in a multipart/form-data body part where name="fileData".
+    type: object
+    properties:
+      contentBodyId:
+        description: The content body id
+        type: string
+      contentModifiedDate:
+        description: File specific last modified date that can be used to set a client-side
+          modified date.
+        type: string
+        required: false
+      desc:
+        description: Description of the file to be uploaded.
+        type: string
+        required: false
+      fieldName:
+        description: Name of a custom field on the ContentVersion object.
+        type: string
+        required: false
+      fieldValue:
+        description: Value to store in the custom field specified by FieldName.
+        type: string
+        required: false
+      firstPublishLocationId:
+        description: The record id of the first published location
+        type: string
+        required: false
+      includeExternalFilePermissionsInfo:
+        description: Whether or not we want to retrieve external file permissions
+          information when creating a TPCF
+        type: boolean
+        required: false
+      isInMyFileSync:
+        description: Whether a file is synced.
+        type: boolean
+        required: false
+      isMajorVersion:
+        description: Whether a file is a major version.
+        type: boolean
+        required: false
+      networkId:
+        description: The network id
+        type: string
+      parentFolderId:
+        description: The parent folder ID of the file.
+        type: string
+        required: false
+      pathOnClient:
+        description: The path on client
+        type: string
+      repositoryFileId:
+        description: The external file identifier.
+        type: string
+        required: false
+      repositoryFileUri:
+        description: The external file uri.
+        type: string
+        required: false
+      repositoryId:
+        description: The Files Connect external data source identifier.
+        type: string
+        required: false
+      reuseReference:
+        description: Whether or not to reuse an existing reference to a repository
+          files instead of creating a new one
+        type: boolean
+        required: false
+      sharingOption:
+        description: File sharing option that can be use to prevent further file sharing.
+        type: string
+        required: false
+      sharingPrivacy:
+        description: File sharing privacy to make the file private on records.
+        type: string
+        required: false
+      title:
+        description: Title of the file.
+        type: string
+  FileUploadConfigRepresentation:
+    description: Information about a file upload config
+    type: object
+    properties:
+      hasCustomRecordTypes:
+        description: Flag to indicate if ContentVersion has custom record types
+        type: boolean
+      maxFileAttachmentsOnFeed:
+        description: Get the Maximum File Attachments on Feed
+        type: integer
+      token:
+        description: The CSRF Token for the file upload request. This token is used
+          to authenticate the file upload
+        type: string
+      uploadUrl:
+        description: Get the file upload url. This is the decoupled mode url
+        type: string
+  FileDetailRepresentation:
+    description: Detail description of a file.
+    type: object
+    properties:
+      id:
+        description: Id of the content document
+        type: string | nil
+      fileAsset:
+        description: The asset information about this file.
+        type: FileAssetRepresentation | nil
+      pageCount:
+        description: Number of pages for documents that support flash renditions,
+          or the number of slides in a presentation. Returns 0 if the flash rendition
+          fails, or if it isn't supported for the file type.
+        type: integer | nil
+      topics:
+        description: Gets the topics associated with a file.
+        type: TopicCollectionRepresentation | nil
+      checksum:
+        description: MD5 checksum for the file.
+        type: string | nil
+      contentHubRepository:
+        description: The external datasource associated with this file, or null if
+          it does not point to an external file.
+        type: ContentHubRepositoryRepresentation | nil
+      contentModifiedDate:
+        description: File specific modified date, which is only updated for direct
+          file operations, e.g. rename. This can also be optionally initialized by
+          users to reflect the file's modified date outside of the cloud. ISO8601
+          date string, for example, 2011-02-25T18:24:31.000Z.
+        type: string | nil
+      contentSize:
+        description: Size of the file in bytes.
+        type: integer | nil
+      contentUrl:
+        description: If the file is a link, returns the URL, otherwise null.
+        type: string | nil
+      contentVersionId:
+        description: The content version ID for this file
+        type: string | nil
+      createdDate:
+        description: Returns the file creation date. ISO8601 date string, for example,2011-02-25T18:24:31.000Z.
+        type: string | nil
+      description:
+        description: Description of the file.
+        type: string | nil
+      downloadUrl:
+        description: URL to the file contents.
+        type: string | nil
+      externalDocumentUrl:
+        description: The external URL this file points to, or null if it does not
+          point to an external file.
+        type: string | nil
+      externalFilePermissionInformation:
+        description: External file permission related information (available groups,
+          available permission types, current sharing status). Will contain the failure
+          reason if it was to fail. Null if includeExternalFilePermissionsInfo is
+          false or non external files
+        type: ExternalFilePermissionInformationRepresentation | nil
+      fileExtension:
+        description: Extension of the file.
+        type: string | nil
+      fileType:
+        description: Type of file, such as PDF, PowerPoint, and so on.
+        type: string | nil
+      flashRenditionStatus:
+        description: Specifies the status of the rendering of the flash preview of
+          the file. Should be either Processing, Failed, Success, or Na if unavailable.
+        type: string | nil
+      isFileAsset:
+        description: Indicates whether this file is an asset or not
+        type: boolean | nil
+      isInMyFileSync:
+        description: Indicates whether the file is synced.
+        type: boolean | nil
+      isMajorVersion:
+        description: Indicates whether the latest version of the file is a major version.
+        type: boolean | nil
+      mimeType:
+        description: File's MIME type.
+        type: string | nil
+      moderationFlags:
+        description: Flags for this file. Community moderators can view and take action
+          on flagged items. Null if network moderation is not enabled.
+        type: ModerationFlagsRepresentation | nil
+      modifiedDate:
+        description: Salesforce standard last modified date of the file in the cloud,
+          i.e. any modifications to the file from within Salesforce will update this.
+          ISO8601 date string, for example, 2011-02-25T18:24:31.000Z.
+        type: string | nil
+      name:
+        description: Name of the file.
+        type: string | nil
+      origin:
+        description: 'Specifies the file source. Valid values are: Chatter -- file
+          came from Chatter, Content -- file came from content, FileField -- file
+          came from a record or other form.'
+        type: string | nil
+      owner:
+        description: Owner of the file.
+        type: UserSummaryRepresentation | nil
+      parentFolder:
+        description: The folder containing this file.
+        type: ReferenceRepresentation | nil
+      pdfRenditionStatus:
+        description: Specifies the status of the rendering of the PDF preview of the
+          file. Should be either Processing, Failed, Success, or Na if unavailable.
+        type: string | nil
+      publishStatus:
+        description: Indicates the publish status of a file.
+        type: string | nil
+        enum:
+          - PendingAccess
+          - PrivateAccess
+          - PublicAccess
+      renditionUrl:
+        description: URL to the rendition for the file if available. Renditions are
+          processed asynchronously and may not be available immediately after the
+          file has been uploaded. This defaults to the 120px by 90px size.Note that
+          the image returned will be as large as possible up to the rendition type
+          size while maintaing the aspect ratio.
+        type: string | nil
+      renditionUrl240By180:
+        description: URL to the 240px by 180px rendition for the file if available.
+          Renditions are processed asynchronously and may not be available immediately
+          after the file has been uploaded.Note that the image returned will be as
+          large as possible up to 240px by 180px while maintaing the aspect ratio.
+        type: string | nil
+      renditionUrl720By480:
+        description: URL to the 720px by 480px rendition for the file if available.
+          Renditions are processed asynchronously and may not be available immediately
+          after the file has been uploaded.Note that the image returned will be as
+          large as possible up to 720px by 480px while maintaing the aspect ratio.
+        type: string | nil
+      repositoryFileId:
+        description: The id of this file in its external repository. Null if the file
+          is not an external file
+        type: string | nil
+      repositoryFileUrl:
+        description: The URL of the Connect endpoint giving access to the external
+          repository file properties, or null if this file does not point to an external
+          file.
+        type: string | nil
+      sharingOption:
+        description: Contains the sharing option of a file.
+        type: string | nil
+        enum:
+          - Allowed
+          - Restricted
+      sharingPrivacy:
+        description: Contains the sharing privacy of a file.
+        type: string | nil
+        enum:
+          - None
+          - PrivateOnRecords
+      sharingRole:
+        description: Indicates the sharing type of a file.
+        type: string | nil
+        enum:
+          - Admin
+          - Collaborator
+          - Owner
+          - Viewer
+          - WorkspaceManaged
+      systemModstamp:
+        description: Returns SystemModstamp of the file. When a user updates the record
+          or any automated system processes(like triggers) updates the record, SystemModstamp
+          will be updated. ISO8601 date string, for example, 2011-02-25T18:24:31.000Z.
+        type: string | nil
+      textPreview:
+        description: Text preview of the file if available, null otherwise.
+        type: string | nil
+      thumb120By90RenditionStatus:
+        description: Specifies the status of the rendering of the 120x90 pixel sized
+          preview image of the file. Should be either Processing, Failed, Success,
+          or Na if unavailable.
+        type: string | nil
+      thumb240By180RenditionStatus:
+        description: Specifies the status of the rendering of the 240x180 pixel sized
+          preview image of the file. Should be either Processing, Failed, Success,
+          or Na if unavailable.
+        type: string | nil
+      thumb720By480RenditionStatus:
+        description: Specifies the status of the rendering of the 720x480 pixel sized
+          preview image of the file. Should be either Processing, Failed, Success,
+          or Na if unavailable.
+        type: string | nil
+      title:
+        description: Title of the file.
+        type: string | nil
+      versionNumber:
+        description: Version number of the file.
+        type: string | nil
+      mySubscription:
+        description: If the logged-in user is following this user, this contains information
+          about the subscription, else returns null.
+        type: ReferenceRepresentation | nil
+      motif:
+        description: Small, medium, and large icons indicating the record's type.
+        type: MotifRepresentation | nil
+      type:
+        description: A fixed type name for this object that can be checked to determine
+          the shape of a payload.
+        type: string | nil
+      url:
+        description: URL to the Connect resource for this object.
+        type: string | nil
+  TopicCollectionRepresentation:
+    description: Used to return a list of topics.
+    type: object
+    properties:
+      currentPageUrl:
+        description: URL to the current page of topics.
+        type: string | nil
+      nextPageUrl:
+        description: URL to the next page of topics.
+        type: string | nil
+      topics:
+        description: List of topics.
+        type: array
+        items:
+          type: TopicRepresentation | nil
+  ModerationFlagItemRepresentation:
+    description: Represents flag details on a moderation enabled entity.
+    type: object
+    properties:
+      createdBy:
+        description: The flagger id.
+        type: string
+      createdDate:
+        description: The visibility access for the user.
+        type: string
+      id:
+        description: The moderation id.
+        type: string
+      moderationType:
+        description: The moderation type.
+        type: string
+        enum:
+          - FlagAsInappropriate
+          - FlagAsSpam
+      note:
+        description: The additional note added by flagger.
+        type: string
+      visibility:
+        description: The visibility access for the user.
+        type: string
+        enum:
+          - ModeratorsOnly
+          - SelfAndModerators
+  ModerationFlagsCollectionRepresentation:
+    description: Represents list of flags on a feed item or comment or a content document.
+    type: object
+    properties:
+      currentPageToken:
+        description: The current page URL.
+        type: string
+      currentPageUrl:
+        description: The current page URL.
+        type: string
+      flags:
+        description: The list of flag details for a feed element.
+        type: array
+        items:
+          type: ModerationFlagItemRepresentation
+      nextPageToken:
+        description: The current page URL.
+        type: string
+      nextPageUrl:
+        description: The next page URL.
+        type: string
+      pageSize:
+        description: The default page size for the queue representation.
+        type: integer
+  ModerationFlagsRepresentation:
+    description: Represents a number of flags on a feed item or comment.
+    type: object
+    properties:
+      flagCount:
+        description: The number of moderation flags on this feed item or comment,
+          will be null if the user does not have permission to view the number of
+          moderation flags (the context user is not a moderator).
+        type: integer
+      flagCountByReason:
+        description: Returns the count of moderaton flags categorized by reasons.
+        type: object
+        properties:
+          //:
+            type: integer
+      flaggedByMe:
+        description: True if the context user has flagged it for moderation; false
+          otherwise.
+        type: boolean
+      flags:
+        description: Returns the collection of moderaton flags.
+        type: ModerationFlagsCollectionRepresentation
+  MotifRepresentation:
+    description: Describes the UI for an object. URL properties give icon URLs. Common
+      record types in Chatter are files, users, and groups, but all record types have
+      a set of motif icons. Custom object records use their tab style icon. All icons
+      are available to unauthenticated users so that, for example, you can display
+      the motif icons in an email.
+    type: object
+    properties:
+      color:
+        description: Hexidecimal color definition.
+        type: string
+      largeIconUrl:
+        description: Large icon.
+        type: string
+      mediumIconUrl:
+        description: Medium icon.
+        type: string
+      smallIconUrl:
+        description: Small icon.
+        type: string
+      svgIconUrl:
+        description: Vector graphics icon.
+        type: string | nil
+  OutOfOfficeRepresentation:
+    description: User's OutOfOfficeMessage
+    type: object
+    properties:
+      message:
+        description: out of office message of the user
+        type: string
+  PhotoRepresentation:
+    description: A profile photo for a user, group, or record.
+    type: object
+    properties:
+      fullEmailPhotoUrl:
+        description: URL to image data in a large format. Delivered in a URL that
+          does not require authentication but will expire after 30 days.
+        type: string
+      largePhotoUrl:
+        description: URL to image data in a large format. Requires an authenticated
+          connection.
+        type: string
+      mediumPhotoUrl:
+        description: URL to image data in a medium format. Requires an authenticated
+          connection.
+        type: string
+      photoVersionId:
+        description: String that can be used as a version check for photos. Photos
+          can be cached until this value changes.
+        type: string | nil
+      smallPhotoUrl:
+        description: URL to image data in a small format. Requires an authenticated
+          connection.
+        type: string
+      standardEmailPhotoUrl:
+        description: URL to image data in a small format. Delivered in a URL that
+          does not require authentication but will expire after 30 days.
+        type: string
+      url:
+        description: URL to this photo's content.
+        type: string
+  ReferenceRepresentation:
+    description: A reference to another record in the organization without including
+      all of the information about that record.
+    type: object
+    properties:
+      id:
+        description: The ID of the object being referenced, which could be an 18-character
+          ID or some other string identifier.
+        type: string
+      url:
+        description: URL to the resource endpoint.
+        type: string
+  ReputationLevelRepresentation:
+    description: Reputation level for a network member or network.
+    type: object
+    properties:
+      levelImageUrl:
+        description: The reputation level image URL.
+        type: string
+      levelName:
+        description: The name of the reputation level.
+        type: string
+      levelNumber:
+        description: The reputation level number is the numerical rank of the reputation
+          level, starting with 1 for the lowest number of points and increasing by
+          reputation point ranges defined by the administrator.
+        type: integer
+  ReputationRepresentation:
+    description: The network member's reputation.
+    type: object
+    properties:
+      reputationLevel:
+        description: Reputation Level.
+        type: ReputationLevelRepresentation
+      reputationPoints:
+        description: The reputation points of a network member earned from events
+          and actions performed in the community.
+        format: double
+        type: number
+      url:
+        description: An endpoint URL that can be used to access a network member's
+          reputation points.
+        type: string
+  RepositoryGroupSummaryRepresentation:
+    description: Detail description of a group entry.
+    type: object
+    properties:
+      groupType:
+        description: The type of group
+        type: string
+        enum:
+          - Everybody
+          - EverybodyInDomain
+          - Unknown
+      name:
+        description: The name of group
+        type: string
+      domain:
+        description: Domain of the directory entry.
+        type: string
+      email:
+        description: Email of the directory entry.
+        type: string
+      id:
+        description: Identifier of the directory entry.
+        type: string
+      type:
+        description: Type of directory entry.
+        type: string
+        enum:
+          - GroupEntry
+          - UserEntry
+  TopicImagesRepresentation:
+    description: Topic Images associated with a Topic
+    type: object
+    properties:
+      coverImageUrl:
+        description: URL to the Topic Cover Image.
+        type: string
+      featuredImageUrl:
+        description: URL to the Topic Featured Image.
+        type: string
+  TopicRepresentation:
+    description: A Chatter topic, either hashtag (v66.0 and earlier) or new topic
+      (v66.0 and later).
+    type: object
+    properties:
+      createdDate:
+        description: ISO8601 date string, for example, 2011-02-25T18:24:31.000Z.
+        type: string
+      description:
+        description: Description of the topic.
+        type: string
+      id:
+        description: 18-character ID of the topic.
+        type: string
+      images:
+        description: Topic images for the topic.
+        type: TopicImagesRepresentation
+      isBeingDeleted:
+        description: if Topic is currently being deleted.
+        type: boolean
+      name:
+        description: Name of the topic.
+        type: string
+      nonLocalizedName:
+        description: Non-localized name of the topic.
+        type: string
+      talkingAbout:
+        description: Number of people talking about this topic over the last two months,
+          based on factors such as topic additions and comments on posts with the
+          topic.
+        type: integer
+      url:
+        description: URL to the Connect resource for the topic.
+        type: string
+  UserSummaryRepresentation:
+    description: Basic details of a user in the organization.
+    type: object
+    properties:
+      isActive:
+        description: true if user is active, false otherwise.
+        type: boolean
+      additionalLabel:
+        description: An additional label (if any) for the user, e.g. "Customer", "Partner",  or
+          "Acme Corporation".
+        type: string | nil
+      communityNickname:
+        description: Community Nickname.
+        type: string
+        required: false
+      companyName:
+        description: Name of the company.
+        type: string
+      displayName:
+        description: Display Name or Community Nickname.
+        type: string
+      firstName:
+        description: User's first name.
+        type: string
+      id:
+        description: 18-char ID of this record.
+        type: string
+      motif:
+        description: Small, medium, and large icons indicating the record's type.
+        type: MotifRepresentation
+      url:
+        description: URL to the Connect resource for this object.
+        type: string
+      isInThisCommunity:
+        description: true if the user is in the community used in the request. false
+          otherwise.
+        type: boolean
+      lastName:
+        description: User's last name.
+        type: string
+      mySubscription:
+        description: If the logged-in user is following this user, this contains information
+          about the subscription, else returns null.
+        type: ReferenceRepresentation | nil
+      name:
+        description: Locale-based concatenation of first and last names.
+        type: string
+      outOfOffice:
+        description: An additional label (if any) for the user for out of office status
+        type: OutOfOfficeRepresentation
+      photo:
+        description: Information about the user's photo.
+        type: PhotoRepresentation
+      reputation:
+        description: The user's reputation in the community, which is determined by
+          the number of points they earn from events and actions performed in the
+          community.
+        type: ReputationRepresentation | nil
+      type:
+        description: A fixed type name for this object that can be checked to determine
+          the shape of a payload.
+        type: string | nil
+      title:
+        description: Title of the user.
+        type: string | nil
+      userType:
+        description: 'Type of user. Valid values are: ChatterGuest—User is a Chatter
+          customer in an external group; Guest—Unauthenticated users; Internal—User
+          is a standard organization member Portal—User is a Customer Portal User,
+          a communities user, and so on; System—User is Chatter Expert or a system
+          user.'
+        type: string
+        enum:
+          - ChatterGuest
+          - ChatterOnly
+          - Guest
+          - Internal
+          - Portal
+          - System
+          - Undefined
+  FilePreviewRepresentation:
+    description: Description of a file preview.
+    type: object
+    properties:
+      format:
+        description: Represents the format of the preview.
+        type: string
+        enum:
+          - Jpg
+          - Pdf
+          - Svg
+          - Thumbnail
+          - ThumbnailBig
+          - ThumbnailTiny
+      previewUrlCount:
+        description: Represents the number of preview items this preview type has.
+        type: integer
+      previewUrls:
+        description: Represents a URI to retrieve the preview for a specific preview.
+        type: array
+        items:
+          type: FilePreviewUrlRepresentation
+      status:
+        description: Represents the availability status of the preview.
+        type: string
+        enum:
+          - Available
+          - InProgress
+          - NotAvailable
+          - NotScheduled
+      url:
+        description: The URL for this representation, which summaries the preview
+          for the specified format.
+        type: string
+  FilePreviewUrlRepresentation:
+    description: Represents the information to retrieve a preview item of a file.
+    type: object
+    properties:
+      pageNumber:
+        description: Preview Page Number (Optional)
+        type: integer
+      previewUrl:
+        description: Represents the file preview URL.
+        type: string
+
+/connect/file/upload/config:
+  get:
+    displayName: getFileUploadConfig
+    description: Get the file uploader config
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FileUploadConfigRepresentation
+
+/connect/files/users/{userId}:
+  post:
+    displayName: createContentDocFromContentBody
+    description: Upload a new file to a user's file share.
+    responses:
+      '200':
+        description: Success
+        body:
+          application/json:
+            type: FileDetailRepresentation
+    body:
+      application/json:
+        type: FileInputRepresentation
+        (oas-body-name): file
+  uriParameters:
+    userId:
+      type: string
+      required: true
+/connect:
+  /communities:
+    /{communityId}:
+      /files:
+        /{fileId}:
+          /previews/{previewFormat}:
+            get:
+              displayName: getFilePreviewCommunity
+              description: Returns a specific preview format representation for
+                a file
+              responses:
+                '200':
+                  description: Success
+                  body:
+                    application/json:
+                      type: FilePreviewRepresentation
+              queryParameters:
+                endPageNumber:
+                  description: 0-based page number of the last URL to retrieve (inclusive)
+                  type: integer
+                  required: false
+                startPageNumber:
+                  description: 0-based page number of the first URL to retrieve
+                  type: integer
+                  required: false
+                versionNumber:
+                  description: The specific version of the file if not specified
+                    defaults to the latest
+                  type: integer
+                  required: false
+            uriParameters:
+              communityId:
+                type: string
+                required: true
+              fileId:
+                type: string
+                required: true
+              previewFormat:
+                type: string
+                required: true
+  /files:
+    /{fileId}:
+      /previews/{previewFormat}:
+        get:
+          displayName: getFilePreview
+          description: Returns a specific preview format representation for a file
+          responses:
+            '200':
+              description: Success
+              body:
+                application/json:
+                  type: FilePreviewRepresentation
+          queryParameters:
+            endPageNumber:
+              description: 0-based page number of the last URL to retrieve (inclusive)
+              type: integer
+              required: false
+            startPageNumber:
+              description: 0-based page number of the first URL to retrieve
+              type: integer
+              required: false
+            versionNumber:
+              description: The specific version of the file if not specified defaults
+                to the latest
+              type: integer
+              required: false
+        uriParameters:
+          fileId:
+            type: string
+            required: true
+          previewFormat:
+            type: string
+            required: true