Sunbird UCI Documentation Related Changes List | V2

[pankajjangid05]

Need to Change

• [ ] Update to v2 APIs
  1. Setting up your very first conversation
  2. Firebase Notification Adapter
  3. Bot Setup Apis
  4. History Api
  5. Direct Message Send Apis Need to change URLs.
  6. Link Need to change the URL of save credentials in the vault.
• [ ] Link not working | URL Change
  1. Sample ODK Excel Form
  2. firebase details of UCI
  3. page The tokens registered can be fetched via the API
  4. page Create a new service here with the fetch token API in config.
  5. page Create a new user segment here with the service created in step 3. Or you can use an already created user segment for this case. cf085492-266f-46d1-841c-1b38e93bce3f.
  6. page Create a new service here with the your token API.
  7. page Create a new user segment here with the service created in step 4.
  8. page Add Enviorment Variable in IDE.
  9. page VAULT_SERVICE_URL=http://143.110.183.73:3001
• [ ] Need to check broadcast-transformer configuration and verify if is it according to v2 configuration or not link
• [ ] Need to change existing implementation code URLs with the latest branch code
  1. Adapter
  2. Converter
  3. Outbound Implementation
• [ ] Change to the latest branch link

Need to Discuss

• [ ] All the API's URLs should be on a single URL Exp :
  1. Doc Sample URL 1: http://localhost:9999/admin/v1/forms/upload
  2. Doc Sample URL 2: http://143.110.255.220:9090/message/send
• [ ] Media Upload API-related changes in ODK Form API
• [ ] Should we add conversation history API in the document?

Docker deploy related changes

• [ ] Some new changes were added in the docker deploy repository by Tushar, so we need to check this document and verify all steps are right or need some changes link

[karntrehan]

• Update Setting up your very first conversation with new install steps.
• Does Setting up your very first conversation really work? What about orgId, adapterId and transformerId? Do we prepack a few elements already?
• What about environment variables for admin panel? Does that need to be updated as well?
• UCI Basics - Add a diagram to show how the various elements work together.

Should we add conversation history API in the document?

Yes. We should atleast start with all of them which were covered in NL chatbot.

All the API's URLs should be on a single URL Exp :

All should be localhost as the assumption is people have already deployed locally using docker.

[geeky-abhishek]

@karntrehan to review

[chinmoy12c]

Planning is done, we'll break this into smaller tickets. Moving to done.

[susheelvar]

@chinmoy12c to break into sub-tickets.