Skip to content
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

Jump to bottom

Document API endpoit usage #48

Open
3 tasks
rodmaia opened this issue Jul 1, 2019 · 1 comment
Open
3 tasks

Document API endpoit usage #48

rodmaia opened this issue Jul 1, 2019 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@rodmaia
Copy link
Collaborator

rodmaia commented Jul 1, 2019 •
edited
Loading

Some endpoints have a more complex usage pattern. Utters, for example, can have one or more content alternatives, and each alternative can have multiple strings (balloons).

This type of usage needs to be clearly documented so new contributors know how to explore the full potential of the API.

See also #42

Tasks

  • Consider naming utterText to something more clear, like utterTextAlternative
  • Steps to complete this task

Acceptance criteria

  • Developers outside the Botflow team know how to use the API just by reading the documentation
@rodmaia rodmaia added the documentation Improvements or additions to documentation label Jul 1, 2019
@rodmaia rodmaia mentioned this issue Jul 1, 2019
Closed
6 tasks
@rodmaia rodmaia mentioned this issue Feb 23, 2021
Open
5 tasks
@mansogf mansogf self-assigned this Feb 25, 2021
@mansogf mansogf mentioned this issue Feb 25, 2021
Open
4 tasks
@mansogf
Copy link
Collaborator

mansogf commented Feb 25, 2021

Following the procedures according to #153.

@mansogf mansogf assigned mansogf and Miguel-Alves and unassigned mansogf Apr 8, 2021
@Miguel-Alves Miguel-Alves removed their assignment Apr 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rodmaia @Miguel-Alves @mansogf