Skip to content

Commit 07c5113

Browse files
committed
updated packages and generated build
1 parent 616f990 commit 07c5113

File tree

7 files changed

+100
-63
lines changed

7 files changed

+100
-63
lines changed

dist/rapidoc-min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

dist/rapidoc-min.js.gz

22 Bytes
Binary file not shown.

dist/report.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

docs/rapidoc-min.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/specs/temp.yaml

Lines changed: 89 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,52 +1,89 @@
1-
openapi: 3.0.3
2-
info:
3-
title: Sample API
4-
description: Retrieves user by country and city
5-
version: 0.1.9
6-
servers:
7-
- url: http://api.example.com/v1
8-
components:
9-
examples:
10-
example1:
11-
value: "ua"
12-
summary: "example $ref ua"
13-
example2:
14-
value: "pl"
15-
summary: "example $ref pl"
16-
example3:
17-
value: 0
18-
paths:
19-
/users/{country}/{city}:
20-
get:
21-
summary: Returns a list of users.
22-
parameters:
23-
- name: 'country'
24-
required: true
25-
in: 'path'
26-
schema:
27-
type: 'string'
28-
examples:
29-
example1:
30-
$ref: '#/components/examples/example1'
31-
example2:
32-
$ref: '#/components/examples/example2'
33-
example3:
34-
$ref: '#/components/examples/example3'
35-
- name: 'city'
36-
required: true
37-
in: 'path'
38-
schema:
39-
type: 'string'
40-
examples:
41-
example1:
42-
value: "uk"
43-
summary: "example inline uk"
44-
responses:
45-
'200': # status code
46-
description: A JSON array of user names
47-
content:
48-
application/json:
49-
schema:
50-
type: array
51-
items:
52-
type: string
1+
{
2+
"openapi": "3.0.0",
3+
"info": {
4+
"title": "Example API",
5+
"version": "1.1",
6+
"description": "Test Schema"
7+
},
8+
"paths": {
9+
"/token": {
10+
"summary": "Generate Token",
11+
"post": {
12+
"tags": [
13+
"User"
14+
],
15+
"parameters": [
16+
{
17+
"name": "username",
18+
"description": "Enter your login username.",
19+
"schema": {
20+
"type": "string",
21+
"example": "user1"
22+
},
23+
"in": "query",
24+
"required": true
25+
},
26+
{
27+
"name": "password",
28+
"description": "Enter your login password.",
29+
"schema": {
30+
"type": "string",
31+
"format": "password",
32+
"example": "pp"
33+
},
34+
"in": "query",
35+
"required": true
36+
},
37+
{
38+
"name": "tokenLifeTime",
39+
"description": "Enter the number of days for the token life time. By default, it will expire after 1 day. Maximum is 30 days.",
40+
"schema": {
41+
"type": "integer",
42+
"example": 0
43+
},
44+
"in": "query",
45+
"required": false
46+
}
47+
],
48+
"responses": {
49+
"200": {
50+
"content": {
51+
"application/json": {
52+
"examples": {
53+
"success": {
54+
"value": "message: { Token created successfully}"
55+
}
56+
}
57+
}
58+
},
59+
"description": "If token is created successfully, check the response Headers."
60+
}
61+
},
62+
"operationId": "getToken",
63+
"summary": "Generate Access Token",
64+
"description": "Using the endpoint & parameters below, you can create an API request that can be used in a number of different ways to generate your authentication token. Most importantly, this method is useful for setting up an automated token renewal process. Your token will be supplied via the Authorization header using the Bearer Token schema. For security reasons, tokens are only valid for a limited period. Use the <i>tokenLifeTime</i> parameter to indicate the desired life time of your token (By default, token will expire after 1 day. Maximum is 30 days).\r\n\r\n\r\n\r\nThese are the supported parameters:"
65+
}
66+
}
67+
},
68+
"components": {
69+
"securitySchemes": {
70+
"JWT": {
71+
"scheme": "bearer",
72+
"type": "http",
73+
"description": "This API uses JWT authentication tokens (JSON Web Tokens) to validate all endpoints. The first step for accessing these endpoints is to generate a JWT authentication token, since all API endpoints require a valid token. For security reasons, tokens are only valid for a limited period (By default, tokens will expire after 1 day. Maximum is 30 days)."
74+
}
75+
}
76+
},
77+
"security": [
78+
{
79+
"JWT": [
80+
]
81+
}
82+
],
83+
"tags": [
84+
{
85+
"name": "User",
86+
"description": ""
87+
}
88+
]
89+
}

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"babel-loader": "^8.1.0",
5050
"babel-plugin-template-html-minifier": "^4.1.0",
5151
"clean-webpack-plugin": "^3.0.0",
52-
"compression-webpack-plugin": "^4.0.1",
52+
"compression-webpack-plugin": "^5.0.0",
5353
"css-loader": "^4.2.1",
5454
"eslint": "^7.7.0",
5555
"eslint-config-airbnb": "^18.2.0",

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2566,10 +2566,10 @@ compressible@~2.0.16:
25662566
dependencies:
25672567
mime-db ">= 1.38.0 < 2"
25682568

2569-
compression-webpack-plugin@^4.0.1:
2570-
version "4.0.1"
2571-
resolved "https://registry.yarnpkg.com/compression-webpack-plugin/-/compression-webpack-plugin-4.0.1.tgz#33eda97f1170dd38c5556771de10f34245aa0274"
2572-
integrity sha512-0mg6PgwTsUe5LEcUrOu3ob32vraDx2VdbMGAT1PARcOV+UJWDYZFdkSo6RbHoGQ061mmmkC7XpRKOlvwm/gzJQ==
2569+
compression-webpack-plugin@^5.0.0:
2570+
version "5.0.0"
2571+
resolved "https://registry.yarnpkg.com/compression-webpack-plugin/-/compression-webpack-plugin-5.0.0.tgz#3903c5eb35af61ed4e773f1675895465479d4201"
2572+
integrity sha512-7igJXv3WgdLpAr+ix4Q0jbnyL43c2kpxhvGXxpP1aQ+Am4zLngU8GoemPZh22OmDCNJ73/DUwV+uumIdp2ltmA==
25732573
dependencies:
25742574
cacache "^15.0.5"
25752575
find-cache-dir "^3.3.1"

0 commit comments

Comments
 (0)