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

Endpoint Clarification #25

Open
AusIV opened this issue Sep 10, 2018 · 5 comments
Open

Endpoint Clarification #25

AusIV opened this issue Sep 10, 2018 · 5 comments

Comments

@AusIV
Copy link
Contributor

AusIV commented Sep 10, 2018

I noticed a discrepancy between the way different relayers are listing their endpoints.

RadarRelay has "https://api.radarrelay.com/0x", OpenRelay has "https://api.openrelay.xyz", both of which expect you to append "/v0" before use, while Amadaeus Relay has "https://api.amadeusrelay.org/api/v0/" and Tokenlon has "https://mainnet-dexapi.tokenlon.im/v1", which both include the version number in the URL.

I was trying to make sure that OpenRelay is set up for v2. Without specifying the version number, our endpoint is still correct, but there seem to be some relayers who specify the version number in their URL and some who don't, so I was hoping that could be clarified.

@tomhschmidt
Copy link
Contributor

Yes, good flag -- 0x Connect takes either I believe, but we should standardize for purposes here. I'm in favor of having a mandatory version appended to the URL, which we can check for in the validation script.

Thoughts @BMillman19 @fragosti @fabioberger

@fragosti
Copy link

fragosti commented Sep 13, 2018

We do explicitly call this out in https://github.com/0xProject/standard-relayer-api#versioning, however we do not explicitly mention this is the auto-generated documentation http://sra-spec.s3-website-us-east-1.amazonaws.com/#operation/getAssetPairs (that we eventually want to integrate into the website). Although, it may be implied by all the example URLs which all have "v2" in them.
I'll make sure to call out versioning in the auto-generated docs as well.

@AusIV
Copy link
Contributor Author

AusIV commented Sep 20, 2018

At some point @tomhschmidt went through and took out the /v0/ from OpenRelay's endpoint address: d8b927b

In any case, I have a PR to mention our Kovan support, but I'm still not clear on whether I should list the /v0/ vs /v2/ endpoints given they were explicitly removed previously (we also support both concurrently).

@fragosti
Copy link

@AusIV you should keep v0 and v2, although I'm not sure why @tomhschmidt removed the version. The commit seems to imply something breaks?

@tomhschmidt
Copy link
Contributor

Cool -- let's standardize around including versions in the endpoint. I'll update the tests and existing relayer endpoints.

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

No branches or pull requests

3 participants