AB-Law / AB-Law/Pluck-It

IWardrobeRepository / WardrobeFunctions: Missing contract documentation on public interface and HTTP endpoints

未关闭
#102 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看
documentation
主要语言
TypeScript
星标
0
派生
0
平均合并
16 分钟
30 天内合并 PR
1

描述

## Problem

`PluckIt.Core/IWardrobeRepository.cs` has no XML documentation on any method. `PluckIt.Functions/Functions/WardrobeFunctions.cs` HTTP endpoints have no documentation on accepted query parameters, request body shape, or returned error codes (400/401/404/422/500).

## Impact

New developers must read through implementation code to understand contracts. API clients (including the Angular frontend) have no specification for error handling.

## Proposed Fix

- Add XML ``, ``, ``, and `` tags to all public interface methods in `IWardrobeRepository`.
- Add a comment block to each `[Function]` handler in `WardrobeFunctions.cs` listing HTTP method, route params, request body schema, and possible error responses.

## Functionality Impact

No runtime change; improves developer experience and reduces onboarding friction.

贡献指南

打开贡献指南

评估

这个 Issue 还没有评估数据。

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。