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.

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

Streaming JSON API: Use same format for archived events as in exercise endpoint #4383

Closed
hurryabit opened this issue Feb 4, 2020 · 0 comments · Fixed by #4439
Closed

Streaming JSON API: Use same format for archived events as in exercise endpoint #4383

hurryabit opened this issue Feb 4, 2020 · 0 comments · Fixed by #4439
Assignees
Labels
component/json-api HTTP JSON API team/ledger-clients Related to the Ledger Clients team's components.

Comments

@hurryabit
Copy link
Contributor

Currently, the archived events in the streaming JSON API look like

{ "archived": "#x:y" }

On the /commands/exercise endpoint they look like

{
  "archived": {
    "templateId": "a:B:C",
    "contractId": "#x:y"
  }
}

I would like to get the latter format on the stream API as well. This consistency makes working with the API easier and more predictable.

@hurryabit hurryabit added this to the HTTP JSON API Maintenance milestone Feb 4, 2020
@S11001001 S11001001 added the wip-issue This issue is being worked on. Use draft PRs for work in progress PRs. label Feb 6, 2020
S11001001 added a commit that referenced this issue Feb 6, 2020
CHANGELOG_BEGIN
- [JSON API - Experimental] The format of ``archived`` responses from WebSocket endpoints
  has changed to include template IDs, similar to exercise responses.
  See `issue #4383 <https://github.com/digital-asset/daml/issues/4383>`_.
CHANGELOG_END
S11001001 added a commit that referenced this issue Feb 7, 2020
…ide contract ID (#4439)

* move InsertDeleteStep to util

* turn append cid argument into a typeclass

* use Cid for appendForgettingDeletes as well

* add secondary data to the deletes in InsertDeleteStep with new covariant tparam

* make StepAndErrors hold ArchivedContracts so ws archives look like exercise archives

* add changelog

CHANGELOG_BEGIN
- [JSON API - Experimental] The format of ``archived`` responses from WebSocket endpoints
  has changed to include template IDs, similar to exercise responses.
  See `issue #4383 <https://github.com/digital-asset/daml/issues/4383>`_.
CHANGELOG_END
@stefanobaghino-da stefanobaghino-da added component/json-api HTTP JSON API team/ledger-clients Related to the Ledger Clients team's components. labels Aug 31, 2021
@S11001001 S11001001 removed the wip-issue This issue is being worked on. Use draft PRs for work in progress PRs. label Nov 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component/json-api HTTP JSON API team/ledger-clients Related to the Ledger Clients team's components.
Projects
None yet
4 participants