@breadstone/archipel-mcp 0.0.39 → 0.0.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -0,0 +1,115 @@
|
|
|
1
|
+
---
|
|
2
|
+
title: 'Class: ProblemDetailResponse'
|
|
3
|
+
generated: true
|
|
4
|
+
editUrl: false
|
|
5
|
+
---
|
|
6
|
+
# Class: ProblemDetailResponse
|
|
7
|
+
|
|
8
|
+
Defined in: models/response/ProblemDetailResponse.ts:29
|
|
9
|
+
|
|
10
|
+
OpenAPI schema class representing a Problem Detail response as per RFC 9457.
|
|
11
|
+
|
|
12
|
+
This class is used exclusively for Swagger / OpenAPI documentation. It is
|
|
13
|
+
**not** instantiated at runtime — the actual response body is produced by
|
|
14
|
+
[ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter).
|
|
15
|
+
|
|
16
|
+
The static [MEDIA\_TYPE](#media_type) property signals to the `@Api` decorator
|
|
17
|
+
that this response schema must be served under `application/problem+json`
|
|
18
|
+
instead of the default `application/json`.
|
|
19
|
+
|
|
20
|
+
Usage in controllers:
|
|
21
|
+
```typescript
|
|
22
|
+
@Api({
|
|
23
|
+
responses: [
|
|
24
|
+
{ status: HttpStatus.NOT_FOUND, description: 'User not found.', type: ProblemDetailResponse },
|
|
25
|
+
]
|
|
26
|
+
})
|
|
27
|
+
```
|
|
28
|
+
|
|
29
|
+
## Constructors
|
|
30
|
+
|
|
31
|
+
### Constructor
|
|
32
|
+
|
|
33
|
+
```ts
|
|
34
|
+
new ProblemDetailResponse(): ProblemDetailResponse;
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
#### Returns
|
|
38
|
+
|
|
39
|
+
`ProblemDetailResponse`
|
|
40
|
+
|
|
41
|
+
## Properties
|
|
42
|
+
|
|
43
|
+
### code?
|
|
44
|
+
|
|
45
|
+
```ts
|
|
46
|
+
optional code?: string;
|
|
47
|
+
```
|
|
48
|
+
|
|
49
|
+
Defined in: models/response/ProblemDetailResponse.ts:81
|
|
50
|
+
|
|
51
|
+
***
|
|
52
|
+
|
|
53
|
+
### detail
|
|
54
|
+
|
|
55
|
+
```ts
|
|
56
|
+
detail: string;
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Defined in: models/response/ProblemDetailResponse.ts:69
|
|
60
|
+
|
|
61
|
+
***
|
|
62
|
+
|
|
63
|
+
### instance?
|
|
64
|
+
|
|
65
|
+
```ts
|
|
66
|
+
optional instance?: string;
|
|
67
|
+
```
|
|
68
|
+
|
|
69
|
+
Defined in: models/response/ProblemDetailResponse.ts:75
|
|
70
|
+
|
|
71
|
+
***
|
|
72
|
+
|
|
73
|
+
### MEDIA\_TYPE
|
|
74
|
+
|
|
75
|
+
```ts
|
|
76
|
+
readonly static MEDIA_TYPE: "application/problem+json" = 'application/problem+json';
|
|
77
|
+
```
|
|
78
|
+
|
|
79
|
+
Defined in: models/response/ProblemDetailResponse.ts:41
|
|
80
|
+
|
|
81
|
+
The media type for Problem Detail responses as per RFC 9457.
|
|
82
|
+
|
|
83
|
+
This static property is consumed by the `@Api` decorator to override the
|
|
84
|
+
default `application/json` content type when this class is used as a
|
|
85
|
+
response `type`.
|
|
86
|
+
|
|
87
|
+
***
|
|
88
|
+
|
|
89
|
+
### status
|
|
90
|
+
|
|
91
|
+
```ts
|
|
92
|
+
status: number;
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
Defined in: models/response/ProblemDetailResponse.ts:63
|
|
96
|
+
|
|
97
|
+
***
|
|
98
|
+
|
|
99
|
+
### title
|
|
100
|
+
|
|
101
|
+
```ts
|
|
102
|
+
title: string;
|
|
103
|
+
```
|
|
104
|
+
|
|
105
|
+
Defined in: models/response/ProblemDetailResponse.ts:57
|
|
106
|
+
|
|
107
|
+
***
|
|
108
|
+
|
|
109
|
+
### type
|
|
110
|
+
|
|
111
|
+
```ts
|
|
112
|
+
type: string;
|
|
113
|
+
```
|
|
114
|
+
|
|
115
|
+
Defined in: models/response/ProblemDetailResponse.ts:51
|
|
@@ -41,6 +41,7 @@ editUrl: false
|
|
|
41
41
|
| [PageableResponse](Class.PageableResponse) | Base class describing pagination metadata returned alongside list payloads. |
|
|
42
42
|
| [ProblemDetailException](Class.ProblemDetailException) | A NestJS HttpException that represents a Problem Detail as per RFC 7807. |
|
|
43
43
|
| [ProblemDetailExceptionFilter](Class.ProblemDetailExceptionFilter) | A NestJS exception filter that transforms exceptions into Problem Details compliant responses as per RFC 7807. |
|
|
44
|
+
| [ProblemDetailResponse](Class.ProblemDetailResponse) | OpenAPI schema class representing a Problem Detail response as per RFC 9457. |
|
|
44
45
|
| [QuantityResponse](Class.QuantityResponse) | Base class for quantity responses. |
|
|
45
46
|
| [ResponseReturn](Class.ResponseReturn) | - |
|
|
46
47
|
| [SseHub](Class.SseHub) | Represents a server-sent event service. |
|
|
@@ -9,7 +9,7 @@ editUrl: false
|
|
|
9
9
|
function Api(options): ClassDecorator & MethodDecorator & PropertyDecorator;
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Defined in: [decorators/Api.ts:
|
|
12
|
+
Defined in: [decorators/Api.ts:142](https://github.com/RueDeRennes/archipel/blob/main/libs/platform-openapi/src/decorators/Api.ts#L142)
|
|
13
13
|
|
|
14
14
|
Composite Swagger decorator that wraps all NestJS OpenAPI decorators into a single declaration.
|
|
15
15
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@breadstone/archipel-mcp",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.0.40",
|
|
4
4
|
"description": "MCP server providing Archipel platform knowledge - documentation, query patterns, and coding conventions - to AI development tools.",
|
|
5
5
|
"type": "commonjs",
|
|
6
6
|
"main": "./src/main.js",
|