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

Rename JSON API endpoints #4289

Closed
leo-da opened this issue Jan 30, 2020 · 3 comments · Fixed by #4440
Closed

Rename JSON API endpoints #4289

leo-da opened this issue Jan 30, 2020 · 3 comments · Fixed by #4440

Comments

@leo-da
Copy link
Contributor

@leo-da leo-da commented Jan 30, 2020

  • /command/create => /create
  • /command/exercise => /exercise
  • /contracts/lookup => /fetch
  • /contracts/search => /query
  • /contracts/searchForever => /stream/query
  • /contracts/lookupForever => /stream/fetch
  • /parties -- no changes

Related to: #3145

CC @hurryabit

@hurryabit

This comment has been minimized.

Copy link
Contributor

@hurryabit hurryabit commented Jan 30, 2020

@leo-da Can you please rename /search to /query and /searchForever to /queryForever.

@leo-da

This comment has been minimized.

Copy link
Contributor Author

@leo-da leo-da commented Jan 31, 2020

@hurryabit how about
/queryForever => /queryStream or /stream/query
/fetchForever => /fetchStream or /stream/fetch

Having forever in the URL does not feel right :)

@hurryabit

This comment has been minimized.

Copy link
Contributor

@hurryabit hurryabit commented Jan 31, 2020

@hurryabit how about
/queryForever => /queryStream or /stream/query
/fetchForever => /fetchStream or /stream/fetch

Having forever in the URL does not feel right :)

I like the idea. How about

/stream/query
/stream/fetch

Then we don't have "overlapping" URLs.

leo-da added a commit that referenced this issue Jan 31, 2020
CHANGELOG_BEGIN
CHANGELOG_END
mergify bot pushed a commit that referenced this issue Jan 31, 2020
* Add fetch by key stream websocket stream, WIP

* Add fetch by key stream websocket stream, WIP

* new formatting rules

* minor documentation cleanup

* refactoring required for the `lookupForever` stream

* Extracted `StreamQuery` typeclass

* Extracted `StreamQuery` typeclass

* Fix typo

* minor cleanup

* Using polymorphic `A: WebSocketService.StreamQuery` to get `lookupForever` functionality

* Remove unused methods

* Cleanup

* cleanup

* cleanup

* Merge remote-tracking branch 'origin/master' into leo-4075-fetch-by-key-stream

# Conflicts:
#	ledger-service/http-json/src/main/scala/com/digitalasset/http/WebSocketService.scala

* Rename the endpoint so it is compliant with #4289

CHANGELOG_BEGIN
CHANGELOG_END
@leo-da leo-da self-assigned this Feb 5, 2020
@leo-da leo-da added the wip-issue label Feb 5, 2020
leo-da added a commit that referenced this issue Feb 6, 2020
CHANGELOG_BEGIN

[JSON API - Experimental] Rename JSON API endpoints. See #4289.
    /command/create => /create
    /command/exercise => /exercise
    /contracts/lookup => /fetch
    /contracts/search => /query
    /contracts/searchForever => /stream/query
    /contracts/lookupForever => /stream/fetch

CHANGELOG_END
leo-da added a commit that referenced this issue Feb 6, 2020
… changes.

CHANGELOG_BEGIN

[JSON API - Experimental] Rename JSON API endpoints. See #4289 and #3145
    /command/create => /v1/create
    /command/exercise => /v1/exercise
    /contracts/lookup => /v1/fetch
    /contracts/search => /v1/query
    /contracts/searchForever => /v1/stream/query
    /contracts/lookupForever => /v1/stream/fetch
    /parties => /v1/parties

CHANGELOG_END
@leo-da leo-da mentioned this issue Feb 6, 2020
5 of 6 tasks complete
@leo-da leo-da closed this in #4440 Feb 6, 2020
leo-da added a commit that referenced this issue Feb 6, 2020
* Rename JSON API endpoints, add version prefix. Combining two breaking changes.

CHANGELOG_BEGIN

[JSON API - Experimental] Rename JSON API endpoints. See #4289 and #3145
    /command/create => /v1/create
    /command/exercise => /v1/exercise
    /contracts/lookup => /v1/fetch
    /contracts/search => /v1/query
    /contracts/searchForever => /v1/stream/query
    /contracts/lookupForever => /v1/stream/fetch
    /parties => /v1/parties

CHANGELOG_END

* minor update

* fix typo in the logging

* experimental disclosure update

* experimental disclosure update

* experimental disclosure update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

2 participants
You can’t perform that action at this time.