Skip to content

Update the README.md from Dev 2.x #17

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

Merged
merged 2 commits into from
Nov 6, 2025
Merged

Update the README.md from Dev 2.x #17

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
87107ab
Merge pull request #16 from apvee/main
fabiofranzini Nov 6, 2025
d373bf1
refactor: remove example code and endpoints from README.md for clarity
fabiofranzini Nov 6, 2025
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
32 changes: 0 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,29 +44,6 @@ A powerful extension for **Azure Functions V4** that automatically generates and
- 🎨 **Customizable** - Full control over your OpenAPI specification
- 📊 **Zod Integration** - Leverage Zod for runtime validation and type safety

#### 🚀 Quick Example

```typescript
import { z } from 'zod';
import { createOpenAPIHttpTrigger } from '@apvee/azure-functions-openapi';

const TodoSchema = z.object({
id: z.string(),
title: z.string(),
completed: z.boolean()
});

export const getTodo = createOpenAPIHttpTrigger({
summary: 'Get a todo item',
responses: {
200: { description: 'Success', schema: TodoSchema }
},
handler: async (context) => {
return { status: 200, body: { id: '1', title: 'Example', completed: false } };
}
});
```

[📚 Full Documentation](./packages/azure-functions-openapi/README.md)

---
Expand All @@ -85,15 +62,6 @@ A comprehensive **sample application** demonstrating the usage of the OpenAPI li
- 🧪 **Real-World Scenarios** - Webhook handlers, batch operations, and more
- 📚 **Learning Resource** - Well-commented code to help you get started

#### 🗂️ Example Endpoints

- `GET /api/todos` - List all todos
- `GET /api/todos/{id}` - Get a single todo
- `POST /api/todos` - Create a new todo
- `PUT /api/todos/{id}` - Update a todo
- `DELETE /api/todos/{id}` - Delete a todo
- `POST /api/todos/export` - Export todos to various formats

[📚 View Examples](./packages/test-functions/src/functions)

---
Expand Down