search

NASA-PDS / pds-api

PDS web APIs specifications and user's manual
http://nasa-pds.github.io/pds-api
Other
5 stars 3 forks source link

As a API user, I want the API to be idempotent. #69

Open jordanpadams opened 3 years ago

jordanpadams commented 3 years ago

Motivation

...so that I can when making multiple identical requests has the same effect as making a single request.

Additional Details

https://restfulapi.net/idempotent-rest-apis/

Acceptance Criteria

Given When I perform Then I expect

Engineering Details

tloubrieu-jpl commented 3 years ago

@jordanpadams I am thinking the API is already idempotent (unless the data is updated in the registry). Do you have an example where it is not in mind ?

jordanpadams commented 3 years ago

@tloubrieu-jpl this was in response to @al-niessner's comment in the API spec regarding the use of POST: https://github.com/NASA-PDS/pds-api/blob/master/docs/spec/pds-api-specification.md#verbs . I wasn't sure if / how that was implemented, so instead I made sure to capture the possible upgrade in the future in both the API Spec and with this story. if that is not the case, then we should update the spec accordingly and close this out.

tloubrieu-jpl commented 3 years ago

thanks @jordanpadams , we can discuss that with @al-niessner during a breakout since I don't think I understand the implication of that sentence either. To me it sounds more like a requirements we should have on future development but it is a good thing to keep this ticket open so that this is clearer eventually.