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

Change exchangeId to id in exchange creation response #453

Open
kezike opened this issue Feb 17, 2025 · 1 comment
Open

Change exchangeId to id in exchange creation response #453

kezike opened this issue Feb 17, 2025 · 1 comment

Comments

@kezike
Copy link

kezike commented Feb 17, 2025

I noticed that the exchange creation endpoint section specifies an exchangeId property in the response. I believe this should be id (this issue is an exchange analog to this workflow issue)?

@dlongley
Copy link
Contributor

Yes, I believe there's an error here. The general rule is that the key name should be id if it is scoped within the exchange itself and exchangeId if it is not within the exchange object itself but is being referenced by some other object.

The exchange creation endpoint should return a location header with the exchange ID as its value and either return a 204 response code (no content) or a 200 with the exchange information, whereby the exchangeId key should be id as stated above. Alternatively, the exchange could be returned underneath an exchange property to allow for other metadata to be returned -- this might be better. Either way the id key name would be used inside the exchange object.

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

2 participants