Deprecate validityPeriod and extendedValidityPeriod in POST /product

Description

Background
With the addition of temporalValidity in https://samtrafiken.atlassian.net/browse/BOBX-53, the POST /product response property validityPeriod has become redundant. There is also an ambiguity in regard to what it represents, the absolute validity or the relative validity (or other).

The POST /product request property adjacency.extendedValidityPeriod has the same ambiguity. Adding properties requestedRelativeValidity and requestedAbsoluteValidity as replacements would enable requesting both an extended (or reduced) relative validity and absolute validity. The requestedRelativeValidity and requestedAbsoluteValidity may be useful in other cases than adjacency-related, thus they should not reside in adjacency.

Suggestion

  • Deprecate validityPeriod and refer to temporalValidity

  • Deprecate adjacency.extendedValidityPeriod

  • Add requestedRelativeValidity

  • Add requestedAbsoluteValidity

Motivation

It would be clearer and easier to know which property should be used and for what purpose.

Proposed solution

Please find the proposed solution here:

https://bitbucket.org/samtrafiken/bob-api-product/branch/BOBX-64-deprecate-validityperiod-v3#diff

Attachments

3
  • 27 Jan 2022, 04:05 PM

Confluence content

mentioned on

Activity

Show:
Done

Details

Assignee

Reporter

Versioning

Minor

Priority

Who's Looking?

Open Who's Looking?
Created January 11, 2022 at 3:52 PM
Updated September 15, 2022 at 1:13 PM
Resolved September 15, 2022 at 1:13 PM
Who's Looking?

Flag notifications