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

URLs returned in meta-data should use proper RFC6570 URL Templates #372

Open
adrianhopebailie opened this issue Nov 28, 2016 · 4 comments
Open

Comments

@adrianhopebailie
Copy link
Contributor

There is a standard way to represent URL templates that will work better across platforms. We've already had to do some hacking to accommodate the current URL templates when consuming them in a Java client.

This change would mean the following URL templates would go from:

"urls" : {
    "accounts" : "http://localhost/accounts",
    "account" : "http://localhost/accounts/:name",
    "transfer_fulfillment" : "http://localhost/transfers/:id/fulfillment",
  },

to this:

"urls" : {
    "accounts" : "http://localhost/accounts",
    "account" : "http://localhost/accounts/{name}",
    "transfer_fulfillment" : "http://localhost/transfers/{id}/fulfillment",
  },

See https://tools.ietf.org/html/rfc6570

@emschwartz
Copy link
Contributor

Do you think we should change this for the Five Bells Ledger API or keep this for the Common Ledger API?

@adrianhopebailie
Copy link
Contributor Author

Do you think we should change this for the Five Bells Ledger API or keep this for the Common Ledger API?

I think it makes sense to do both. For Common Ledger API there is no impact so it's easier. For five-bells we need to assess the impact on other components so could be lower priority until we can do that.

@emschwartz
Copy link
Contributor

This change has actually already been proposed for the Common Ledger API (see here).

Unless this is causing major problems in implementing the Five Bells Ledger API I would propose not changing the variable format in that API. I think that falls into the category of API cleanup and we decided to postpone most of those types of changes until we switch to the Common Ledger API.

@justmoon
Copy link
Contributor

justmoon commented Dec 7, 2016

Agreed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants