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

indicating information up-to-dateness #43

Open
juliuste opened this issue Jul 27, 2018 · 6 comments
Open

indicating information up-to-dateness #43

juliuste opened this issue Jul 27, 2018 · 6 comments

Comments

@juliuste
Copy link
Member

I think it would make sense to introduce an attribute to FPTF@2 objects that indicates the up-to-dateness of the given information. This would enable us (e.g.) to provide a combination of static and realtime data in FPTF (where more up-to-date information overwrites older information).

Such an attribute could for example be called asOf, effective or updated and would contain a date string. It could also be required since this information is basically almost always available, as far as I know?

Opinions?

@derhuerst
Copy link
Member

Sounds good. I'd add a general section mentioning this optional, but "reserved", field.

There are multiple properties of a data item that might be interesting:

  • When has the item been created?
  • When has the item been updated the last time?
  • For how long is the item valid?

Unfortunately, different properties are relevant.

@juliuste
Copy link
Member Author

juliuste commented Aug 4, 2018

Sounds good. I'd add a general section mentioning this optional, but "reserved", field.

Why not make it required? Or are you talking about FPTF@1?

There are multiple properties of a data item that might be interesting:

  • When has the item been created?
  • When has the item been updated the last time?
  • For how long is the item valid?

I certainly agree that we should/could add some optional property for indicating how long an item is valid, but I don't see the necessity to separate the time an item has been created from the time one has been updated. I think the more general approach would just be to assume that the ”newer“ of two objects with the same id would be the more up-to-date. (Example: A feed of stopover objects where you would ”update“ an object by publishing a new one with the same id but a more recent date and e.g. updated departure information).

@derhuerst
Copy link
Member

Sounds good. I'd add a general section mentioning this optional, but "reserved", field.

Why not make it required? Or are you talking about FPTF@1?

Because I'd like to avoid to extend the set of required fields beyond what's necessary, in order to keep the barrier to adopting it low.

I think the more general approach would just be to assume that the ”newer“ of two objects with the same id would be the more up-to-date. (Example: A feed of stopover objects where you would ”update“ an object by publishing a new one with the same id but a more recent date and e.g. updated departure information).

This sounds like a sensible and intuitive way, but I'm not sure we can fit the semantics of all APIs into this format.

@juliuste
Copy link
Member Author

Because I'd like to avoid to extend the set of required fields beyond what's necessary, in order to keep the barrier to adopting it low.

I understand this argument for fields that are not available in every API, but this is different here, right?

@juliuste
Copy link
Member Author

@derhuerst ping

1 similar comment
@juliuste
Copy link
Member Author

@derhuerst ping

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

No branches or pull requests

2 participants