Skip to content

feat: create api design best practices #251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
pengying wants to merge 1 commit into from
Closed

feat: create api design best practices #251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions openapi/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# API Design Guidelines
This readme is a continually evolving document meant to provide API design best practices for the following purposes.

1. API feels consistent
2. Preempt known bad patterns
3. Make new APIs easy to define

## Directory structure


## Naming Conventions
### Common fields
| Name | Description |
|---|---|
| timestamp | timestamp an event occurred
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 The last row of the Markdown table is missing a closing pipe |. Without it, many Markdown renderers (GitHub, Mintlify, etc.) will either skip rendering the row or misformat the table entirely.

Suggested change
| timestamp | timestamp an event occurred
| timestamp | timestamp an event occurred |
Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/README.md
Line: 15

Comment:
The last row of the Markdown table is missing a closing pipe `|`. Without it, many Markdown renderers (GitHub, Mintlify, etc.) will either skip rendering the row or misformat the table entirely.

```suggestion
| timestamp | timestamp an event occurred |
```

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code


## Service Structure
Prefer stuff
Comment on lines +17 to +18
Copy link
Copy Markdown

@greptile-apps greptile-apps Bot May 13, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P2 Placeholder text left in document

The ## Service Structure section contains only Prefer stuff, which reads as an unfinished placeholder. If this document is intended to be merged and referenced by engineers writing new APIs, shipping it with placeholder content may cause confusion or be followed literally. The ## Directory structure section (lines 8–10) is also empty with no content at all.

Prompt To Fix With AI 
This is a comment left during a code review.
Path: openapi/README.md
Line: 17-18

Comment:
**Placeholder text left in document**

The `## Service Structure` section contains only `Prefer stuff`, which reads as an unfinished placeholder. If this document is intended to be merged and referenced by engineers writing new APIs, shipping it with placeholder content may cause confusion or be followed literally. The `## Directory structure` section (lines 8–10) is also empty with no content at all.

How can I resolve this? If you propose a fix, please make it concise.

Fix in Claude Code