kalviumcommunity/Supply-Chain-Cargo-Management-Maersk-Hackathon

Define API LLD and contract for Cargo Management endpoint and error handling

Open

#14 opened on Oct 1, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Vue (1 fork)auto 404
documentationgood first issue

Repository metrics

Stars
 (1 star)
PR merge metrics
 (No merged PRs in 30d)

Description

Description:

  • Establish a low-level API contract to align frontend (Vue.js) and backend (Spring Boot) development.
  • Document a sequence flow of a typical API request through Controller, Service, Repository, and DB layers.
  • Specify the POST /api/cargo endpoint including request/response schemas and headers to enable parallel implementation.
  • Standardize API error response formats for 400, 404, and 500 to ensure consistent client handling.
  • Provide a versioned reference document to serve as a blueprint for Week 2 implementation.

Deliverables:

  • API sequence diagram: Visualize end-to-end request flow.
  • Endpoint spec: Define POST /api/cargo request/response.
  • Success contract: Include 201 Created with Location header.
  • Error schema: Standardize 400/404/500 JSON structures.
  • Documentation artifact: Create docs/lld-api-outline.md with version/date.

Contributor guide

Research direction
Review the existing codebase for any API patterns, then design the POST /api/cargo endpoint with request/response schemas and error handling structure. Document in docs/lld api outline.md.
Tech stack
vuejavaspring
Domain
backendapi
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GitREST API
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75