node-slack-sdk icon indicating copy to clipboard operation
node-slack-sdk copied to clipboard

Add documentaiton for Blocks

Open tal opened this issue 6 years ago • 9 comments

Summary

I was starting to make a bot that uses the new Blocks api, in my process of learning how it works I documented all the types to teach myself about them, thought this would be useful in everyone's text editor to have each field and type documented with links to relevant docs.

These are all copied from the current iteraiton of the official slack documentation.

Requirements

tal avatar Apr 11 '19 18:04 tal

CLA assistant check
All committers have signed the CLA.

CLAassistant avatar Apr 11 '19 18:04 CLAassistant

@tal this looks awesome! thanks for contributing back as you figured things out.

i can take a closer look and leave feedback later this week, but in the meantime there are some test failures related to exceeding the maximum line length and a couple missing semicolons. would you mind fixing those up?

aoberoi avatar Apr 11 '19 21:04 aoberoi

For sure. I’ll fix those up. While you look through there are some things that are undocumented on slacks api doc site. If you can check it’d be good to know if they’re supported or no.

On Thu, Apr 11, 2019 at 5:18 PM Ankur Oberoi [email protected] wrote:

@tal https://github.com/tal this looks awesome! thanks for contributing back as you figured things out.

i can take a closer look and leave feedback later this week, but in the meantime there are some test failures related to exceeding the maximum line length and a couple missing semicolons. would you mind fixing those up?

— You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub https://github.com/slackapi/node-slack-sdk/pull/767#issuecomment-482318018, or mute the thread https://github.com/notifications/unsubscribe-auth/AABJ2qxbP9VuxMYu6YAygtxZMLGUmT8nks5vf6a_gaJpZM4cqkWI .

-- -Tal

tal avatar Apr 11 '19 21:04 tal

Codecov Report

Merging #767 into master will not change coverage. The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #767   +/-   ##
=======================================
  Coverage   97.85%   97.85%           
=======================================
  Files          15       15           
  Lines         652      652           
  Branches       26       26           
=======================================
  Hits          638      638           
  Misses         13       13           
  Partials        1        1
Flag Coverage Δ
#eventsapi 95.62% <ø> (ø) :arrow_up:
#interactivemessages 99.18% <ø> (ø) :arrow_up:
#webapi 98.33% <ø> (ø) :arrow_up:
#webhook 90.69% <ø> (ø) :arrow_up:

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 961f9d8...e1c88ae. Read the comment docs.

codecov[bot] avatar Apr 15 '19 16:04 codecov[bot]

Codecov Report

:exclamation: No coverage uploaded for pull request base (main@19db04b). Click here to learn what that means. The diff coverage is n/a.

@@           Coverage Diff           @@
##             main     #767   +/-   ##
=======================================
  Coverage        ?   97.85%           
=======================================
  Files           ?       15           
  Lines           ?      652           
  Branches        ?       26           
=======================================
  Hits            ?      638           
  Misses          ?       13           
  Partials        ?        1           
Flag Coverage Δ
eventsapi 95.62% <ø> (?)
interactivemessages 99.18% <ø> (?)
webapi 98.33% <ø> (?)
webhook 90.69% <ø> (?)

Flags with carried forward coverage won't be shown. Click here to find out more.

:mega: We’re building smart automated test selection to slash your CI/CD build times. Learn more

codecov[bot] avatar Apr 15 '19 16:04 codecov[bot]

Fixed line length

tal avatar Apr 15 '19 16:04 tal

These are pretty useful. We've been playing around with the types too so thanks for going to the effort of sorting the docs out.

43081j avatar Sep 14 '19 20:09 43081j

@tal Just a small bump on the review edits here. If any of them need clarification, let me know 😄

If you don't plan on landing this anymore, that's fine. If you could toggle the Allow edits from maintainers (https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork), I can finish up the PR and keep your previous commits

shaydewael avatar Sep 18 '19 16:09 shaydewael

Edits by maintainers should have always been enabled, and is now.

tal avatar Sep 18 '19 16:09 tal