Skip to content

Commit

Permalink
feat(rest): add annotations page
Browse files Browse the repository at this point in the history
  • Loading branch information
jlenon7 committed Jan 6, 2024
1 parent fb66a26 commit 2a63d12
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 7 deletions.
2 changes: 2 additions & 0 deletions docs/cli-application/annotations.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ description: Check all available Artisan annotations and it options.

# Annotations

Check all available Artisan annotations and it options.

## `@Argument()`

Define an argument for an Artisan command class:
Expand Down
27 changes: 27 additions & 0 deletions docs/rest-api-application/annotations.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: Annotations
sidebar_position: 6
toc_max_heading_level: 2
description: Check all available REST API annotations and it options.
---

# Annotations

Check all available REST API annotations and it options.

## `@Controller()`

Comming soon...

## `@Middleware()`

Comming soon...

## `@Interceptor()`

Comming soon...

## `@Terminator()`

Comming soon...

2 changes: 1 addition & 1 deletion docs/rest-api-application/rate-limiting.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Rate Limiting
sidebar_position: 6
sidebar_position: 7
description: See how to create rate limiting rules for Athenna REST API application.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/rest-api-application/security-with-helmet.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Security with Helmet
sidebar_position: 8
sidebar_position: 9
description: See how to improve the security of your REST API with Helmet in Athenna.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/rest-api-application/swagger-documentation.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Swagger Documentation
sidebar_position: 9
sidebar_position: 10
description: See how to create the Swagger documentation for Athenna REST API application.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/rest-api-application/tracing-requests.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Tracing Requests
sidebar_position: 7
sidebar_position: 8
description: Understand how to trace requests in your REST API application of Athenna.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/annotations.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Annotations
sidebar_position: 4
sidebar_position: 2
description: Check all available testing annotations and it options.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/cli-tests.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: CLI Testing
sidebar_position: 3
sidebar_position: 4
description: See how to create tests for CLI applications in Athenna.
---

Expand Down
2 changes: 1 addition & 1 deletion docs/testing/rest-api-testing.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: REST API Testing
sidebar_position: 2
sidebar_position: 3
description: See how to create tests for REST APIs applications in Athenna.
---

Expand Down

0 comments on commit 2a63d12

Please sign in to comment.