[Task] Verify all apis implemented

[maruTA-bis5]

Based on: https://github.com/mattermost/mattermost-api-reference/tree/519eaaf96ce39c74123d63eae36d47a2dd0afccf
If missing / wrong api found, create issues to fix it.

Note

• APIs that can accept Etag are not documented in mattermost-api-reference, but implemented in mattermost-server.

Check list

• AuditsApi - In api document, audit related apis written in system section.
  • Invalid
    • needless Etag overload: #getAudits -> Remove needless overloads that has etag parameter #180
• AuthenticationApi - In api document, #switchAccountType in users section.
• BrandApi
• ChannelApi
  • Missing
    • GET /channels/{channel_id}/timezones -> Implement: GET /channels/{channel_id}/timezones #107
    • PUT /channels/{channel_id}/patch -> Implement: PUT /channels/{channel_id}/patch #181
    • GET /teams/{team_id}/channels/autocomplete = Implement: Channel Autocomplete APIs #182
    • GET /teams/{team_id}/channels/search_autocomplete -> Implement: Channel Autocomplete APIs #182
    • #addChannelMembers: post_root_id parameter-> ChannelApi#addChannelMembers: post_root_id parameter support #183
    • PUT /channels/{channel_id}/members/{user_id}/schemeRoles -> Implement: Roles API #201
      • Notice: Mattermost4j does not support scheme based roles currently.
    • PUT /channels/{channel_id}/scheme -> Implement: Schemes API #202
  • Invalid
    • needless Etag overloads: except getPinnedPosts and getChannelsForTeamForUser -> Remove needless overloads that has etag parameter #180
• ClusterApi
• CommandsApi
• ComplianceApi
• ElasticsearchApi
• EmojiApi
  • Missing
    • #getEmojiList: sort parameter -> EmojiApi#getEmojiList: sort parameter support #184
• FilesApi
  • Missing
    • #uploadFile: client_ids, channel_id(in query), and filename(in query) parameters -> FilesApi#uploadFile: more parameter support #185
• GeneralApi (SystemApi, Rename GeneralApi to SystemApi #117)
  • Missing
    • POST /file/s3_test -> Implement: POST /file/s3_test #186
    • GET /config/environment -> Implement: GET /config/environment #187
• LdapApi
• LogsApi - In api document, log related apis written in system section.
• OAuthApi
  • Missing
    • PUT /oauth/apps/{app_id} -> Implement: PUT /oauth/apps/{app_id} #58
• PluginApi
• PostApi
  • MIssing
    • #searchPosts: time_zone_offset and include_deleted_channels parameters. -> PostApi#searchPosts: more parameters support #188
    • POST /posts/{post_id}/actions/{action_id} -> Implement: Post Actions #110
      • Notice: Mattermost4j does not support post action currently.
  • Concern
    • Deprecate #updatePost(String, Post) API to removal. Use #updatePost(Post) instead. -> Make PostApi#updatePost(String, Post) Deprecate #189
• PreferencesApi
• ReactionApi
  • Missing
    • POST /posts/ids/reactions -> Add new API for 5.8 #156
• SamlApi
  • Concern
    • Rename #{upload,remove}SamlPrivateCertificate to #{upload,remove}SamlPrivateKey -> Rename API: SamlApi#{upload,remove}SamlPrivateCertificat to ~PrivateKey #190
• StatusApi
  • Invalid
    • needless Etag overload: #getUserStatus -> Remove needless overloads that has etag parameter #180
• TeamApi
  • Missing
    • PUT /teams/{team_id}/members/{user_id}/schemeRoles -> Implement: Roles API #201
      • Notice: Mattermost4j does not support scheme based roles currently.
    • DELETE /teams/invites/email -> Implement: DELETE /teams/invites/email #191
    • PUT /teams/{team_id}/scheme -> Implement: Schemes API #202
      • Notice: Mattermost4j does not support scheme based roles currently.
  • Invalid
    • needless Etag overload: all apis -> Remove needless overloads that has etag parameter #180
    • missing Etag overload: #getTeamIcon -> Add etag parameter for TeamApi#getTeamIcon #192
    • test TeamsApiTest#addUserToTeamFromInvite is marked ignore and may be invalid api call. -> Test: TeamsApi#addUserToTeamFromInvite #193
    • GET /users/{user_id}/teams/unread is defined as UserApi#getTeamUnreadForUser. Move to TeamApi. -> Move UserApi#getTeamUnreadForUser method declaration into TeamApi #194
• UserApi
  • Missing
    • #searchUsers, #autocompleteUsers, #autocompleteUsersInChannel, #autocompleteUsersInTeam: limit parameter -> User Search Apis: add limit parameter support #195
    • GET /users/stats -> Implement: GET /users/stats #196
    • GET /users/{user_id}/image/default -> Implement: GET /users/{user_id}/image/default #197
    • PUT /users/{user_id}/auth -> Implement: PUT /users/{user_id}/auth #70
    • POST /users/{user_id}terms_of_service -> Implement: Service Terms API #203
    • GET /users/{user_id}terms_of_service -> Implement: Service Terms API #203
  • Invalid
    • needless Etag overload: #autocompleteUsers, #autocompleteUsersInChannel, #autocompleteUsersInTeam, #getMe, #getSessions, #getUser, #getUserAudits, #getUserByEmail, #getUserByUsername, #getUsers, #getUsersInChannel. #getUsersInTeam, #getUsersNotInChannel, #getUsersNotInTeam, and #getUsersWithoutTeam. -> Remove needless overloads that has etag parameter #180
  • Concern
    • Rename parameter to same as mattermost api doc: UserApi#resetPassword: token to code -> UserApi#resetPassword: rename parameter token to code #198
• WebhookApi
  • Invalid
    • needless Etag overload: All api -> Remove needless overloads that has etag parameter #180
• WebrtcApi - Already removed from api-doc (Make WebrtcApi deprecated #94).
• others
  • Missing
    • actions.yaml -> Implement: Post Actions #110
    • dataretention.yaml -> Implement: GET /data_retention/policy #59
    • groups.yaml (LDAP groups) -> Implement: Groups API #199
    • jobs.yaml -> Implement: Jobs endpoint #34
    • opengraph.yaml -> Implement: OpenGraph API #200
    • roles.yaml -> Implement: Roles API #201
    • schemes.yaml -> Implement: Schemes API #202
    • service_terms.yaml -> Implement: Service Terms API #203
  • Verify and update description: correct Pager parameter usage? -> [Task] Verify Pager parameter usage correct #179
    • For example, GET /users/{user_id}/audits accept page/per_page parameters, but not explained in api documentation (this is document's bug).

[maruTA-bis5]

All sub tasks are converted to issues.