@manyos/smileconnect-api 1.72.2 → 1.72.3
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.
|
Binary file
|
|
Binary file
|
|
@@ -62,3 +62,46 @@ customResponse.data = {
|
|
|
62
62
|
|
|
63
63
|
customResponse.code = 203
|
|
64
64
|
```
|
|
65
|
+
|
|
66
|
+
## Custom OpenAPI Specification
|
|
67
|
+
|
|
68
|
+
Since ScriptEnpoint parameters and responses are defined in your scripts, no automatic documentation generation is possible. You can define a custom OpenAPI specification for your script endpoint. This allows you to define the request and response schema for your endpoint.
|
|
69
|
+
|
|
70
|
+
The OpenAPI specification is defined in the endpoint's metadata. The following example shows a valid OpenAPI specification for a ScriptEndpoint. You can specify the request and response schemas as JSON objects as well as a summary and description.
|
|
71
|
+
|
|
72
|
+
```javascript
|
|
73
|
+
{
|
|
74
|
+
"summary": "Run scripts associated with this endpoint",
|
|
75
|
+
"description": "Run scripts associated with this endpoint",
|
|
76
|
+
"requestSchema": {
|
|
77
|
+
"type": "object",
|
|
78
|
+
"properties": {
|
|
79
|
+
"loginid": {
|
|
80
|
+
"type": "string",
|
|
81
|
+
"maxLength": 15,
|
|
82
|
+
"description": "Login ID"
|
|
83
|
+
}
|
|
84
|
+
},
|
|
85
|
+
"required": [
|
|
86
|
+
"loginid"
|
|
87
|
+
]
|
|
88
|
+
},
|
|
89
|
+
"responseSchema": {
|
|
90
|
+
"type": "object",
|
|
91
|
+
"properties": {
|
|
92
|
+
"approver": {
|
|
93
|
+
"type": "string",
|
|
94
|
+
"description": "Approver username"
|
|
95
|
+
}
|
|
96
|
+
},
|
|
97
|
+
"required": [
|
|
98
|
+
"approver"
|
|
99
|
+
]
|
|
100
|
+
}
|
|
101
|
+
}
|
|
102
|
+
```
|
|
103
|
+
|
|
104
|
+
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
package/docs/releases.md
CHANGED
package/docs/spec/index.html
CHANGED
|
@@ -1,24 +1,15 @@
|
|
|
1
1
|
<!DOCTYPE html>
|
|
2
2
|
<html>
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
|
|
3
|
+
<head />
|
|
4
|
+
<body>
|
|
5
|
+
<H1>SMILEconnect API Specification</H1>
|
|
6
|
+
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
|
|
7
|
+
<div id="redoc-container"></div>
|
|
9
8
|
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
padding: 0;
|
|
17
|
-
}
|
|
18
|
-
</style>
|
|
19
|
-
</head>
|
|
20
|
-
<body>
|
|
21
|
-
<redoc spec-url='https://smileconnect.manyosdocs.de/openapi.json'></redoc>
|
|
22
|
-
<script src="https://cdn.jsdelivr.net/npm/redoc@next/bundles/redoc.standalone.js"> </script>
|
|
23
|
-
</body>
|
|
9
|
+
<script>
|
|
10
|
+
Redoc.init('https://smileconnect.manyosdocs.de/openapi.json', {
|
|
11
|
+
"showExtensions": true
|
|
12
|
+
}, document.getElementById('redoc-container'))
|
|
13
|
+
</script>
|
|
14
|
+
</body>
|
|
24
15
|
</html>
|