Skip to content

[NOMERGE] feat: openapi migration progress #150

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
ahmed-n-abdeltwab wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

[NOMERGE] feat: openapi migration progress #150

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
34579b4
refactor: remove the webdav from the integrations
ahmed-n-abdeltwab Jul 17, 2025
ec09975
refactor: remove pinMessage endpoint from messaging.yaml
ahmed-n-abdeltwab Jul 29, 2025
e29b515
refactor: remove oauth-apps.create endpoint from integrations.yaml
ahmed-n-abdeltwab Jul 30, 2025
2511f83
refactor: remove auth-apps.list endpoint from integrations.yaml
ahmed-n-abdeltwab Aug 1, 2025
8484c0a
refactor: remove aoth-apps.delete endpoint from integration
ahmed-n-abdeltwab Aug 4, 2025
da38710
refactor: remove auth-app.update from integration.yaml
ahmed-n-abdeltwab Aug 5, 2025
310412e
refactor: remove permissions.list, permissions.update endpoint from u…
ahmed-n-abdeltwab Aug 7, 2025
b818278
refactor: remove oauth-apps.get endpoint from integration.yaml
ahmed-n-abdeltwab Aug 9, 2025
ab7bd56
refactor: remove dm.delete endpoint from messaging.yaml
ahmed-n-abdeltwab Aug 11, 2025
fe1a149
refactor: remove e2e.setRoomKeyID endpoint from settings.yaml
ahmed-n-abdeltwab Aug 15, 2025
f27016e
refactor: remove unPinMessage endpoint from messaging.yaml
ahmed-n-abdeltwab Aug 25, 2025
b1cb26e
Merge branch 'main' into feat/openapi
ahmed-n-abdeltwab Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions integrations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1602,8 +1602,6 @@ paths:
method: deleteOAuthApp
tags:
- name: Integration
- name: OAuth Apps
- name: WebDAV
components:
parameters:
offset:
Expand Down
261 changes: 0 additions & 261 deletions messaging.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1973,198 +1973,6 @@ paths:
errorType: error-invalid-subscription
details:
method: ignoreUser
/api/v1/chat.pinMessage:
post:
tags:
- Chat
summary: Pin Message
description: |-
<a href='https://docs.rocket.chat/docs/message-actions#pin-messages' target='_blank'>Pin</a> a chat message to the channel.

### Changelog
| Version | Description |
| ------------ | ------------|
| 0.59.0 | Added |
operationId: post-api-v1-chat.pinMessage
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
type: object
properties:
messageId:
type: string
description: The message ID that you want to pin.
required:
- messageId
examples:
Example:
value:
messageId: 7aDSXtjMA3KPLxLjt
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
message:
type: object
properties:
_id:
type: string
t:
type: string
rid:
type: string
ts:
type: string
msg:
type: string
u:
type: object
properties:
_id:
type: string
username:
type: string
name:
type: string
groupable:
type: boolean
attachments:
type: array
items:
type: object
properties:
text:
type: string
author_name:
type: string
author_icon:
type: string
ts:
type: string
attachments:
type: array
items:
type: object
_updatedAt:
type: string
success:
type: boolean
examples:
Example 1:
value:
message:
_id: 651f23c0a2f73c7460e18d1a
t: message_pinned
rid: 6GFJ3tbmHiyHbahmC
ts: '2023-10-05T20:59:44.503Z'
msg: ''
u:
_id: 5fRTXMt7DMJbpPJfh
username: test.test
name: Testtest
groupable: false
attachments:
- text: hola
author_name: roxie
author_icon: /avatar/roxie
ts: '2023-10-05T20:30:51.052Z'
attachments: []
_updatedAt: '2023-10-05T20:59:44.521Z'
success: true
'401':
$ref: '#/components/responses/authorizationError'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Example 1:
value:
success: false
error: 'The required "messageId" param is missing. [error-messageid-param-not-provided]'
errorType: error-messageid-param-not-provided
Example 2:
value:
success: false
error: 'The provided "messageId" does not match any existing message. [error-message-not-found]'
errorType: error-message-not-found
/api/v1/chat.unPinMessage:
post:
tags:
- Chat
summary: Unpin a message
description: |-
Remove a pinned message from the channel.

### Changelog
| Version | Description |
| -------------| ------------|
| 0.59.0 | Added |
operationId: post-api-v1-chat.unPinMessage
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
type: object
properties:
messageId:
type: string
description: The message ID you want to to unpin.
required:
- messageId
examples:
Example:
value:
messageId: 7aDSXtjMA3KPLxLjt
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'401':
$ref: '#/components/responses/authorizationError'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Missing Parameter:
value:
success: false
error: 'The required "messageId" param is missing. [error-messageid-param-not-provided]'
errorType: error-messageid-param-not-provided
Invalid Parameter:
value:
success: false
error: 'The provided "messageId" does not match any existing message. [error-message-not-found]'
errorType: error-message-not-found
/api/v1/chat.postMessage:
post:
tags:
Expand Down Expand Up @@ -3868,75 +3676,6 @@ paths:
errorType: error-invalid-user
details:
method: createDirectMessage
/api/v1/dm.delete:
post:
tags:
- DM
summary: Delete DM
description: |-
Delete a DM. Permission required: `view-room-administration`.

### Changelog
| Version | Description |
| ------------ | ------------|
|3.18.0 | Added |
operationId: post-api-v1-im.delete
parameters:
- $ref: '#/components/parameters/Auth-Token'
- $ref: '#/components/parameters/UserId'
requestBody:
content:
application/json:
schema:
oneOf:
- type: object
required: ["roomId"]
properties:
roomId:
type: string
description: The room ID of the DM. This parameter is required if you don't enter the `username` parameter.
- type: object
required: ["username"]
properties:
username:
type: string
description: The username of the user in the DM.
examples:
Example:
value:
roomId: hdy9972092873h8s7s0
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Example 1:
value:
success: false
error: |-
must have required property 'roomId'
must have required property 'username'
must match exactly one schema in oneOf [invalid-params]
errorType: invalid-params
Invalid room ID or username:
value:
success: false
error: '[invalid-channel]'
errorType: invalid-channel
'401':
$ref: '#/components/responses/authorizationError'
/api/v1/dm.files:
get:
tags:
Expand Down
61 changes: 0 additions & 61 deletions settings.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -926,67 +926,6 @@ paths:
name: rid
description: The room ID.
required: true
/api/v1/e2e.setRoomKeyID:
parameters: []
post:
summary: Set Room E2E Key
operationId: post-api-v1-e2e.setRoomKeyID
responses:
'200':
$ref: '#/components/responses/trueSuccess'
'400':
description: Bad Request
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
error:
type: string
errorType:
type: string
examples:
Invalid Params:
value:
success: false
error: 'must have required property ''rid'' [invalid-params]'
errorType: invalid-params
E2E Key Exists:
value:
success: false
error: 'E2E Key ID already exists [error-room-e2e-key-already-exists]'
errorType: error-room-e2e-key-already-exists
details:
method: e2e.setRoomKeyID
'401':
$ref: '#/components/responses/authorizationError'
tags:
- E2E
parameters:
- $ref: '#/components/parameters/X-User-Id'
- $ref: '#/components/parameters/X-Auth-Token'
requestBody:
content:
application/json:
schema:
type: object
properties:
rid:
type: string
description: The room ID.
keyID:
type: string
description: The key that you want to set for the room. Enter a unique string.
required:
- rid
- keyID
examples:
Example:
value:
rid: wCiXndNp5NqNY3uCc
keyID: my-UniQu3_ke4_Id
/api/v1/e2e.setUserPublicAndPrivateKeys:
parameters: []
post:
Expand Down