Framework/openapi.json at main · nimbly/Framework · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
{
	"openapi": "3.0.0",
	"info": {
		"title": "service",
		"description": "service description",
		"version": "1.0"
	},
	"components": {
		"responses": {
			"DefaultError": {
				"description": "Refer to error message for details",
				"content": {
					"application/json": {
						"schema": {
							"type": "object",
							"properties": {
								"code": {
									"type": "integer",
									"format": "int32"
								},

								"message": {
									"type": "string",
									"maxLength": 256,
									"description": "End user friendly error message."
								},

								"debug": {
									"type": "object",
									"description": "The debug object is only included when the application is running in debug mode.",
									"properties": {
										"message": {
											"type": "string",
											"maxLength": 1024,
											"description": "Developer friendly error message."
										},

										"file": {
											"type": "string",
											"maxLength": 256,
											"description": "File exception occured in."
										},

										"line": {
											"type": "integer",
											"format": "int32",
											"minimum": 0,
											"description": "Line number if file exception occured in."
										},

										"trace": {
											"type": "string",
											"maxLength": 131072,
											"description": "Full stack trace of exception."
										},

										"details": {
											"type": "array",
											"description": "If the request failed to validate against the schema, this property will contain additional details.",
											"items": {
												"type": "object",
												"properties": {
													"message": {
														"type": "string",
														"maxLength": 128
													},

													"location": {
														"type": "string",
														"maxLength": 128
													},

													"data": {}
												}
											}
										}
									},
									"additionalProperties": false,
									"required": ["message", "file", "line", "trace"]
								}
							},
							"additionalProperties": false,
							"required": ["code", "message"]
						}
					}
				}
			}
		},
		"schemas": {

		}
	},
	"paths": {
		"/heartbeat": {
			"get": {
				"operationId": "getHeartbeat",
				"summary": "Get service heartbeat.",
				"description": "Get the service heartbeat that should return a successful response if the server is still running.",
				"responses": {
					"200": {
						"description": "Success",
						"content": {
							"application/json": {
								"schema": {
									"type": "object",
									"properties": {
										"status": {
											"type": "string",
											"enum": ["Ok"]
										}
									},
									"required": ["status"]
								}
							}
						}
					},

					"default": {
						"$ref": "#/components/responses/DefaultError"
					}
				}
			}
		}
	}
}