Closed HenrikHL closed 4 days ago
Here are some key observations to aid the review process:
β±οΈ Estimated effort to review: 3 π΅π΅π΅βͺβͺ |
π§ͺ No relevant tests |
π No security concerns identified |
β‘ Recommended focus areas for review API Breaking Change Merging multiple timestamp endpoints into a single endpoint is a breaking change that will require client updates. Validate that all existing functionality is preserved in the new unified endpoint. Missing Properties The new unified Timestamp schema appears to be missing some properties that existed in the original schemas like delayReasonCode, isFYI and remark. Verify if these fields should be preserved. Validation Rules New conditions added for classifierCode usage between consumer/provider need careful review to ensure proper access control and data validation. |
Explore these optional code suggestions:
Category | Suggestion | Score |
General |
β Fix incorrect API endpoint URL in example documentation to prevent confusion___ **Fix the typo in the example requestUri which shows 'ztimestamp' instead of'timestamp'. This could cause confusion for API consumers and documentation readers.** [jit/v2/JIT_v2.0.0.yaml [348]](https://github.com/dcsaorg/DCSA-OpenAPI/pull/450/files#diff-9515d70681d4860776aad1fa65c622e5b362021ad1f0c0ae1352067f49108299R348-R348) ```diff -requestUri: /v2/port-call-services/085a3207-5e45-49cf-8e1b-f8442beaf545/ztimestamp +requestUri: /v2/port-call-services/085a3207-5e45-49cf-8e1b-f8442beaf545/timestamp ``` `[Suggestion has been applied]` Suggestion importance[1-10]: 8Why: The typo in the example URL ('ztimestamp' instead of 'timestamp') could mislead API consumers and cause integration issues. This is particularly important as it's in the API documentation example section. | 8 |
π‘ Need additional feedback ? start a PR chat
User description
SD-1798: Merge timestamp endPoints into a single endPoint
Moves
timestamps
,cancelled
anddeclined
from theSpecification
object -->PortCallService
objectPR Type
enhancement
Description
estimated
,planned
,actual
,requested
) into a single/timestamp
endpoint.PortCallService
object to includetimestamps
,cancelled
, anddeclined
fields, moving them from theSpecification
object.Timestamp
schema, simplifying the API structure.Changes walkthrough π
JIT_v2.0.0.yaml
Consolidate timestamp endpoints and schemas in JIT API
jit/v2/JIT_v2.0.0.yaml
Timestamp
.timestamps
,cancelled
, anddeclined
fields to thePortCallService
object.Timestamp
schema.styleguide.json
...
.stoplight/styleguide.json ...