Air-Intl-Search 문서화 진행 상황

현재 상태: 🟢 문서화 완료

문서화 범위

• 모든 함수, 객체 빠짐없이 문서화
• Caller-Callee 관계 명시
• 요청-응답 관계 발췌 기록

진행 로그

2024-12-17

• obsidian/nol 폴더 생성 완료
• PLAN.md 계획문서 작성 완료
• STATUS.md 작성상황 문서 생성 완료
• 최초 푸시 완료
• 템플릿 파일 수신 완료
• air-intl-search 전체 파일 스캔 (168개 Kotlin 파일)
• 인덱스 파일 생성 (_index.md)
• Controller 계층 문서화 완료 (13개)
• Service 계층 문서화 완료 (19개)
• Infrastructure Client 문서화 완료 (11개)
• Infrastructure DTO 문서화 완료 (17개)
• Domain 계층 문서화 완료 (11개)
• Events/Stream 문서화 완료 (6개)
• Support 핵심 문서화 완료 (28개)
  • cache: 4개 (CacheKeyGenerator, Redis Serializers)
  • configuration: 3개 (ApplicationProperties, InfrastructureProperties, OpenApiProperties)
  • converter: 2개 (EnumConverter, JavaTimeConverter)
  • exception: 2개 (Exceptions, RestExceptionHandler)
  • filter: 2개 (LoggingFilter, MDCFilter)
  • web: 2개 (MDCHolder, ClientSupport)
  • model: 4개 (SearchInfo, OriginDestinationLocationInfo, PassengerInfo, FlightSearchQuery)
  • util: 2개 (CoroutineUtils, Extensions)
  • enums: 5개 (Channel, Funnel, TripType, CabinType, _EnumsIndex)
  • root: 2개 (Constants, MessageKey)

2024-12-18

• Support enums 추가 문서화 완료 (35개)
  • AirRecommendationFunnel, AirRecommendationPolicy
  • AirlineFilterOrderType, AmenityItemTypes
  • BaggageUnit, CacheKeyStatus, CarrierType
  • DirectType, DiscountMethod, DiscountRuleType, DiscountType
  • FareDecisionStrategy, FarePrincipleRuleType, FareRuleType
  • FilterType, FlightGroupCriteria, IdentityType
  • LayoverType, LocationType, MetaFareStrategy
  • MixFlightResponseType, PassengerType, PollingStatus
  • PromotionDiscountType, PromotionRuleType, PromotionStatus
  • RoundingMode, RouteType, RuleMethod, RuleValuesOperator
  • SearchTripDirectionType, SortType, Supplier, SupplierType
  • TagType, TasfMethod, TasfPrincipleType, TasfRuleType
  • TimeSlot, TripDirectionType
• Support model 추가 문서화 완료 (9개)
  • AsyncMapResult, DurationRange, RecommendationRouteCondition
  • Scraping, SelectedFlight, NaverPromotion
  • CombinedFlightItem, FlightDetail, FlightItemPrincipleCriteria
• Support util 추가 문서화 완료 (10개)
  • BeanUtils, BookableDateValidator, CollectionUtils
  • ContinentUtils, DateUtils, Maintenance
  • PromotionBadgeUtils, SearchValidator, ServletUtils, StringUtils

템플릿 파일

파일	용도
function-template	함수/메서드 문서화
object-template	DTO, Entity, Enum 등 객체 문서화

완료된 문서 목록

Controller (13/13) 🟢

분류	파일명	상태
Controller	FlightSearchController	🟢
Controller	FlightDetailController	🟢
Controller	FareRuleController	🟢
Controller	HealthController	🟢
Controller/Internal	FlightSearchInternalController	🟢
Controller/Internal	FlightDetailInternalController	🟢
Controller/Admin	FlightSearchAdminController	🟢
Controller/Admin	FlightMetaSearchAdminController	🟢
Controller/Proxy	FlightSearchProxyController	🟢
Controller/Proxy	FareRuleProxyController	🟢
Controller/Proxy	FlightDetailProxyController	🟢
Controller/Proxy	FlightMetaSearchProxyController	🟢
Controller/Proxy/V2	FlightSearchV2ProxyController	🟢

Service (19/19) 🟢

분류	파일명	상태
Service	FlightSearchService	🟢
Service	FlightDetailService	🟢
Service	FareRuleService	🟢
Service	AirportService	🟢
Service	AirlineService	🟢
Service	AirConsoleService	🟢
Service	LocationService	🟢
Service	BillingService	🟢
Service	BookableDateService	🟢
Service	CityService	🟢
Service	MessageSourceService	🟢
Service	RecommendationService	🟢
Service	AirRecommendationService	🟢
Service	CurationScrapingService	🟢
Service	RecommendationScrapingService	🟢
UseCase	StandardFlightSearchUseCase	🟢
UseCase	SplitFlightSearchUseCase	🟢
UseCase	CombineFlightSearchUseCase	🟢
UseCase	ReissueFlightSearchUseCase	🟢

Infrastructure Client (11/11) 🟢

분류	파일명	상태
adapter	AdapterClient	🟢
pricing	PricingClient	🟢
airconsole	AirConsoleClient	🟢
naver	NaverClient	🟢
city	CityClient	🟢
billing	BillingClient	🟢
airrecommendation	AirRecommendationClient	🟢
recommendation	RecommendationClient	🟢
slack	SlackClient	🟢
flight	FlightClient	🟢
google	GoogleClient	🟢

Infrastructure DTO (17/17) 🟢

분류	파일명	상태
adapter	AdapterErrorResponse	🟢
adapter	FareRuleResponse	🟢
adapter	FlightSearchRequest	🟢
adapter	FlightSearchResponse	🟢
adapter	StructuredFareRuleResponse	🟢
airconsole	AirConsoleResponse	🟢
airrecommendation	AirRecommendationRequest	🟢
airrecommendation	CurationPrincipleResponse	🟢
billing	BillingResponse	🟢
city	CityResponse	🟢
flight	FlightResponse	🟢
naver	NaverRequest	🟢
naver	NaverResponse	🟢
pricing	PricingRequest	🟢
pricing	PricingResponse	🟢
recommendation	RecommendationRequest	🟢
recommendation	RecommendationResponse	🟢

Domain (11/11) 🟢

분류	파일명	상태
domain	FareRule	🟢
domain	FareRuleGroup	🟢
domain	FareRuleInfo	🟢
domain	FareRuleItem	🟢
domain	StructuredFareRule	🟢
domain	CommonFlightItem	🟢
domain	FlightItem	🟢
domain	FlightSearch	🟢
repository	FareRuleRepository	🟢
repository	FlightSearchRepository	🟢
repository	FlightItemRepository	🟢

Events/Stream (6/6) 🟢

분류	파일명	상태
events	SearchScheduleEvent	🟢
events/listener	KinesisEventListener	🟢
stream	AirScheduleProducer	🟢
stream/payload	MessageArgumentPayload	🟢
stream/payload	AirSchedulePayload	🟢
stream/payload/air/schedule	AirScheduleEvent	🟢

Support (82/82) 🟢

cache (4개)

파일명	상태
CacheKeyGenerator	🟢
GzipRedisSerializer	🟢
LZ4RedisSerializer	🟢
SnappyRedisSerializer	🟢

configuration (3개)

파일명	상태
ApplicationProperties	🟢
OpenApiProperties	🟢
InfrastructureProperties	🟢

converter (2개)

파일명	상태
EnumConverter	🟢
JavaTimeConverter	🟢

exception (2개)

파일명	상태
Exceptions	🟢
RestExceptionHandler	🟢

filter (2개)

파일명	상태
LoggingFilter	🟢
MDCFilter	🟢

web (2개)

파일명	상태
MDCHolder	🟢
ClientSupport	🟢

model (13개)

파일명	상태
SearchInfo	🟢
OriginDestinationLocationInfo	🟢
PassengerInfo	🟢
FlightSearchQuery	🟢
AsyncMapResult	🟢
DurationRange	🟢
RecommendationRouteCondition	🟢
Scraping	🟢
SelectedFlight	🟢
NaverPromotion	🟢
CombinedFlightItem	🟢
FlightDetail	🟢
FlightItemPrincipleCriteria	🟢

util (12개)

파일명	상태
CoroutineUtils	🟢
Extensions	🟢
BeanUtils	🟢
BookableDateValidator	🟢
CollectionUtils	🟢
ContinentUtils	🟢
DateUtils	🟢
Maintenance	🟢
PromotionBadgeUtils	🟢
SearchValidator	🟢
ServletUtils	🟢
StringUtils	🟢

enums (40개)

파일명	상태
Channel	🟢
Funnel	🟢
TripType	🟢
CabinType	🟢
_EnumsIndex	🟢
AirRecommendationFunnel	🟢
AirRecommendationPolicy	🟢
AirlineFilterOrderType	🟢
AmenityItemTypes	🟢
BaggageUnit	🟢
CacheKeyStatus	🟢
CarrierType	🟢
DirectType	🟢
DiscountMethod	🟢
DiscountRuleType	🟢
DiscountType	🟢
FareDecisionStrategy	🟢
FarePrincipleRuleType	🟢
FareRuleType	🟢
FilterType	🟢
FlightGroupCriteria	🟢
IdentityType	🟢
LayoverType	🟢
LocationType	🟢
MetaFareStrategy	🟢
MixFlightResponseType	🟢
PassengerType	🟢
PollingStatus	🟢
PromotionDiscountType	🟢
PromotionRuleType	🟢
PromotionStatus	🟢
RoundingMode	🟢
RouteType	🟢
RuleMethod	🟢
RuleValuesOperator	🟢
SearchTripDirectionType	🟢
SortType	🟢
Supplier	🟢
SupplierType	🟢
TagType	🟢
TasfMethod	🟢
TasfPrincipleType	🟢
TasfRuleType	🟢
TimeSlot	🟢
TripDirectionType	🟢

root (2개)

파일명	상태
Constants	🟢
MessageKey	🟢

전체 분석 대상 통계

항목	개수	완료
컨트롤러	13	13 🟢
서비스	19	19 🟢
인프라 Client	11	11 🟢
인프라 DTO	17	17 🟢
도메인	11	11 🟢
이벤트/스트림	6	6 🟢
Support	82	82 🟢
총계	159	159

작업 완료

• Controller 계층 문서화 (13개) 완료
• Service 계층 문서화 (19개) 완료
• Infrastructure Client 문서화 (11개) 완료
• Infrastructure DTO 문서화 (17개) 완료
• Domain 계층 문서화 (11개) 완료
• Events/Stream 문서화 (6개) 완료
• Support 전체 문서화 (82개) 완료

---

상태 범례

• 🔴 시작 전
• 🟡 진행 중
• 🟢 완료

---

마지막 업데이트: 2024-12-18