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

Allowed values of parse field unclear #50

Open
4 of 9 tasks
pluehne opened this issue Feb 15, 2021 · 0 comments
Open
4 of 9 tasks

Allowed values of parse field unclear #50

pluehne opened this issue Feb 15, 2021 · 0 comments

Comments

@pluehne
Copy link

pluehne commented Feb 15, 2021

Description

The set of allowed values for the parse field used by chat.postMessage and chat.update are underspecified and slightly contradictory:

{
"description": "Change how messages are treated. Defaults to `client`, unlike `chat.postMessage`. Accepts either `none` or `full`. If you do not specify a value for this field, the original value set for the message will be overwritten with the default, `client`.",
"in": "formData",
"name": "parse",
"type": "string"
},

On the one hand, the documentation string claims that parse

Accepts either none or full.

On the other hand, it also claims that the field

Defaults to client

which makes me think that the field accepts client, full, and none (or are even more values allowed?).

Also, I didn’t find any good documentation on the full list of allowed values for this field, let alone their semantics.

The only mention of the parse field I could find in the documentation simply states that

You can specify values for parse and link_names to change formatting behavior.
https://api.slack.com/methods/chat.postMessage#formatting

with no further explanation.

I think that both the specification and the documentation should be improved.

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