slackapi / slack-api-specs

Open API specifications for platform products by Slack
MIT License
222 stars 64 forks source link

Allowed values of parse field unclear #50

Open pluehne opened 3 years ago

pluehne commented 3 years ago

Description

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

https://github.com/slackapi/slack-api-specs/blob/760ee9843ec8045ce3f62edd451751b0353acead/web-api/slack_web_openapi_v2_without_examples.json#L11633-L11638

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 [ ])

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