Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

Missing response schema for search.messages endpoint #47

Open
4 of 9 tasks
damienalexandre opened this issue Dec 28, 2020 · 0 comments
Open
4 of 9 tasks

Missing response schema for search.messages endpoint #47

damienalexandre opened this issue Dec 28, 2020 · 0 comments

Comments

@damienalexandre
Copy link

Description

The https://api.slack.com/methods/search.messages endpoint response is not specified:

"/search.messages": {
"get": {
"consumes": [
"application/x-www-form-urlencoded"
],
"description": "Searches for messages matching a query.",
"externalDocs": {
"description": "API method documentation",
"url": "https://api.slack.com/methods/search.messages"
},
"operationId": "search_messages",
"parameters": [
{
"description": "Authentication token. Requires scope: `search:read`",
"in": "query",
"name": "token",
"required": true,
"type": "string"
},
{
"description": "Pass the number of results you want per \"page\". Maximum of `100`.",
"in": "query",
"name": "count",
"type": "integer"
},
{
"description": "Pass a value of `true` to enable query highlight markers (see below).",
"in": "query",
"name": "highlight",
"type": "boolean"
},
{
"in": "query",
"name": "page",
"type": "integer"
},
{
"description": "Search query.",
"in": "query",
"name": "query",
"required": true,
"type": "string"
},
{
"description": "Return matches sorted by either `score` or `timestamp`.",
"in": "query",
"name": "sort",
"type": "string"
},
{
"description": "Change sort direction to ascending (`asc`) or descending (`desc`).",
"in": "query",
"name": "sort_dir",
"type": "string"
}
],
"produces": [
"application/json"
],
"responses": {
"200": {
"description": "Typical success response",
"schema": {
"additionalProperties": true,
"description": "This method either only returns a brief _OK_ response or a verbose schema is not available for this method.",
"properties": {
"ok": {
"$ref": "#/definitions/defs_ok_true"
}
},
"required": [
"ok"
],
"title": "Default success template",
"type": "object"
}
},
"default": {
"description": "Typical error response",
"schema": {
"additionalProperties": true,
"description": "This method either only returns a brief _not OK_ response or a verbose schema is not available for this method.",
"properties": {
"ok": {
"$ref": "#/definitions/defs_ok_false"
}
},
"required": [
"ok"
],
"title": "Default error template",
"type": "object"
}
}
},
"security": [
{
"slackAuth": [
"search:read"
]
}
],
"tags": [
"search"
]
}
},

We only have the "ok" field, not all the data fields of the results.
This is an issue when trying to generate compatible client (jolicode/slack-php-api#59).

What type of issue is this? (place an x in one of the [ ])

  • bug
  • enhancement (feature request)
  • question
  • documentation related
  • testing related
  • discussion

Requirements (place an x in each of the [ ])

  • I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've searched for any related issues and avoided creating a duplicate issue.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant