-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathuser-schema.html
187 lines (164 loc) · 16.1 KB
/
user-schema.html
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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
<!DOCTYPE html><html lang=en> <head><link rel=stylesheet type=text/css href="https://fonts.googleapis.com/css?family=Overpass:300,400,600,800"><script src=https://code.jquery.com/jquery-3.4.1.min.js integrity="sha256-CSXorXvZcTkaix6Yvo6HppcZGetbYMGWSFlBw8HfCJo=" crossorigin=anonymous></script><link href=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/css/bootstrap.min.css rel=stylesheet integrity=sha384-ggOyR0iXCbMQv3Xipma34MD+dH/1fQ784/j6cY/iJTQUOhcWr7x9JvoRxT2MZw1T crossorigin=anonymous><script src=https://stackpath.bootstrapcdn.com/bootstrap/4.3.1/js/bootstrap.min.js integrity=sha384-JjSmVgyd0p3pXB1rRibZUAYoIIy6OrQ6VrjIEaFf/nJGzIxFDsf4x0xIM+B07jRM crossorigin=anonymous></script><style>body {
font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif;
color: #333;
font-weight: 300;
padding: 40px;
}
.btn.btn-link {
font-size: 18px;
}
.jsfh-animated-property {
animation: eclair;
animation-iteration-count: 1;
animation-fill-mode: forwards;
animation-duration: .75s;
}
@keyframes eclair {
0%,100% {
transform: scale(1);
}
50% {
transform: scale(1.03);
}
}
.btn.btn-primary {
margin: 10px;
}
.btn.example-show.collapsed:before {
content: "show"
}
.btn.example-show:before {
content: "hide"
}
.description.collapse:not(.show) {
max-height: 100px !important;
overflow: hidden;
display: -webkit-box;
-webkit-line-clamp: 2;
-webkit-box-orient: vertical;
}
.description.collapsing {
min-height: 100px !important;
}
.collapse-description-link.collapsed:after {
content: '+ Read More';
}
.collapse-description-link:not(.collapsed):after {
content: '- Read Less';
}
.badge {
font-size: 100%;
margin-bottom: 0.5rem;
}
.badge.value-type {
font-size: 120%;
margin-right: 5px;
margin-bottom: 10px;
}
.badge.default-value {
font-size: 120%;
margin-left: 5px;
margin-bottom: 10px;
}
.badge.restriction {
display: inline-block;
}
.badge.required-property,.badge.deprecated-property,.badge.pattern-property,.badge.no-additional {
font-size: 100%;
margin-left: 10px;
}
.accordion div.card:only-child {
border-bottom: 1px solid rgba(0, 0, 0, 0.125);
}
.examples {
padding: 1rem !important;
}
.highlight.jumbotron {
padding: 1rem !important;
}
.generated-by-footer {
margin-top: 1em;
text-align: right;
}
/* From https://github.com/richleland/pygments-css/blob/master/friendly.css, see https://github.com/trentm/python-markdown2/wiki/fenced-code-blocks */
.highlight { background: #e9ecef; } /* Changed from #f0f0f0 in the original style to be the same as bootstrap's jumbotron */
.highlight .hll { background-color: #ffffcc }
.highlight .c { color: #60a0b0; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #FF0000 } /* Error */
.highlight .k { color: #007020; font-weight: bold } /* Keyword */
.highlight .o { color: #666666 } /* Operator */
.highlight .ch { color: #60a0b0; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #60a0b0; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #007020 } /* Comment.Preproc */
.highlight .cpf { color: #60a0b0; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #60a0b0; font-style: italic } /* Comment.Single */
.highlight .cs { color: #60a0b0; background-color: #fff0f0 } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .gr { color: #FF0000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #00A000 } /* Generic.Inserted */
.highlight .go { color: #888888 } /* Generic.Output */
.highlight .gp { color: #c65d09; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #0044DD } /* Generic.Traceback */
.highlight .kc { color: #007020; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #007020; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #007020; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #007020 } /* Keyword.Pseudo */
.highlight .kr { color: #007020; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #902000 } /* Keyword.Type */
.highlight .m { color: #40a070 } /* Literal.Number */
.highlight .s { color: #4070a0 } /* Literal.String */
.highlight .na { color: #4070a0 } /* Name.Attribute */
.highlight .nb { color: #007020 } /* Name.Builtin */
.highlight .nc { color: #0e84b5; font-weight: bold } /* Name.Class */
.highlight .no { color: #60add5 } /* Name.Constant */
.highlight .nd { color: #555555; font-weight: bold } /* Name.Decorator */
.highlight .ni { color: #d55537; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #007020 } /* Name.Exception */
.highlight .nf { color: #06287e } /* Name.Function */
.highlight .nl { color: #002070; font-weight: bold } /* Name.Label */
.highlight .nn { color: #0e84b5; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #062873; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #bb60d5 } /* Name.Variable */
.highlight .ow { color: #007020; font-weight: bold } /* Operator.Word */
.highlight .w { color: #bbbbbb } /* Text.Whitespace */
.highlight .mb { color: #40a070 } /* Literal.Number.Bin */
.highlight .mf { color: #40a070 } /* Literal.Number.Float */
.highlight .mh { color: #40a070 } /* Literal.Number.Hex */
.highlight .mi { color: #40a070 } /* Literal.Number.Integer */
.highlight .mo { color: #40a070 } /* Literal.Number.Oct */
.highlight .sa { color: #4070a0 } /* Literal.String.Affix */
.highlight .sb { color: #4070a0 } /* Literal.String.Backtick */
.highlight .sc { color: #4070a0 } /* Literal.String.Char */
.highlight .dl { color: #4070a0 } /* Literal.String.Delimiter */
.highlight .sd { color: #4070a0; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #4070a0 } /* Literal.String.Double */
.highlight .se { color: #4070a0; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #4070a0 } /* Literal.String.Heredoc */
.highlight .si { color: #70a0d0; font-style: italic } /* Literal.String.Interpol */
.highlight .sx { color: #c65d09 } /* Literal.String.Other */
.highlight .sr { color: #235388 } /* Literal.String.Regex */
.highlight .s1 { color: #4070a0 } /* Literal.String.Single */
.highlight .ss { color: #517918 } /* Literal.String.Symbol */
.highlight .bp { color: #007020 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #06287e } /* Name.Function.Magic */
.highlight .vc { color: #bb60d5 } /* Name.Variable.Class */
.highlight .vg { color: #bb60d5 } /* Name.Variable.Global */
.highlight .vi { color: #bb60d5 } /* Name.Variable.Instance */
.highlight .vm { color: #bb60d5 } /* Name.Variable.Magic */
.highlight .il { color: #40a070 } /* Literal.Number.Integer.Long */</style><script src=https://use.fontawesome.com/facf9fa52c.js></script><script>function flashElement(t){myElement=document.getElementById(t),myElement.classList.add("jsfh-animated-property"),setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(t){history.pushState({},"",t)}function anchorOnLoad(){let t=window.location.hash.split("?")[0].split("&")[0];"#"===t[0]&&(t=t.substr(1)),t.length>0&&anchorLink(t)}function anchorLink(t){$("#"+t).parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(t){if($(this).hasClass("collapse"))$(this).collapse("show");else if($(this).hasClass("tab-pane")){const t=$("a[href='#"+$(this).attr("id")+"']");t&&t.tab("show")}else"tab"===$(this).attr("role")&&$(this).tab("show")}),setTimeout(function(){let e=document.getElementById(t);e&&(e.scrollIntoView({block:"center",behavior:"smooth"}),setTimeout(function(){flashElement(t)},500))},1e3)}$(document).on("click",'a[href^="#"]',function(t){t.preventDefault(),history.pushState({},"",this.href)});</script><meta charset=utf-8><title>User</title></head> <body onload=anchorOnLoad(); id=root><h1>User</h1><span class="badge badge-dark value-type">Type: object</span> <span class="badge badge-success default-value">Default: {}</span> <span class="badge badge-info no-additional">No Additional Properties</span> <span class=description><p>Represents an user</p> </span> <br> <div class="badge badge-secondary">Example:</div> <br><button class="btn btn-light example-show collapsed" data-toggle=collapse data-target=#root_ex1 aria-controls=root_ex1></button><div id=root_ex1 class="collapse jumbotron examples"> <div class=highlight><pre><span></span><span class=p>{</span>
<span class=s2>"email"</span><span class=o>:</span> <span class=s2>"myriam.b@gmail.com"</span><span class=p>,</span>
<span class=s2>"password"</span><span class=o>:</span> <span class=s2>"blabla"</span><span class=p>,</span>
<span class=s2>"firstName"</span><span class=o>:</span> <span class=s2>"Myriam"</span><span class=p>,</span>
<span class=s2>"lastName"</span><span class=o>:</span> <span class=s2>"B"</span><span class=p>,</span>
<span class=s2>"sex"</span><span class=o>:</span> <span class=kc>true</span><span class=p>,</span>
<span class=s2>"age"</span><span class=o>:</span> <span class=mi>23</span><span class=p>,</span>
<span class=s2>"address"</span><span class=o>:</span> <span class=s2>"rue bloblo"</span><span class=p>,</span>
<span class=s2>"city"</span><span class=o>:</span> <span class=s2>"Villeurbanne"</span><span class=p>,</span>
<span class=s2>"country"</span><span class=o>:</span> <span class=s2>"France"</span>
<span class=p>}</span>
</pre></div> </div> <div class=accordion id=accordionemail> <div class=card> <div class=card-header id=headingemail> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#email aria-expanded aria-controls=email onclick="setAnchor('#email')"><span class=property-name>email</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=email class="collapse property-definition-div" aria-labelledby=headingemail data-parent=#accordionemail> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> <span class=description><p>must be valid</p> </span> <br> <div class="badge badge-secondary">Example:</div> <br><div id=email_ex1 class="jumbotron examples"> <div class=highlight><pre><span></span><span class=s2>"myriam.b@gmail.com"</span>
</pre></div> </div> </div> </div> </div> </div> <div class=accordion id=accordionpassword> <div class=card> <div class=card-header id=headingpassword> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#password aria-expanded aria-controls=password onclick="setAnchor('#password')"><span class=property-name>password</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=password class="collapse property-definition-div" aria-labelledby=headingpassword data-parent=#accordionpassword> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> <span class=description><p>must contain 6 to 32 characters</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionfirstName> <div class=card> <div class=card-header id=headingfirstName> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#firstName aria-expanded aria-controls=firstName onclick="setAnchor('#firstName')"><span class=property-name>firstName</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=firstName class="collapse property-definition-div" aria-labelledby=headingfirstName data-parent=#accordionfirstName> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> </div> </div> </div> </div> <div class=accordion id=accordionlastName> <div class=card> <div class=card-header id=headinglastName> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#lastName aria-expanded aria-controls=lastName onclick="setAnchor('#lastName')"><span class=property-name>lastName</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=lastName class="collapse property-definition-div" aria-labelledby=headinglastName data-parent=#accordionlastName> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> </div> </div> </div> </div> <div class=accordion id=accordionsex> <div class=card> <div class=card-header id=headingsex> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#sex aria-expanded aria-controls=sex onclick="setAnchor('#sex')"><span class=property-name>sex</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=sex class="collapse property-definition-div" aria-labelledby=headingsex data-parent=#accordionsex> <div class=card-body><span class="badge badge-dark value-type">Type: boolean</span> <span class=description><p>True = woman. False = man</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionage> <div class=card> <div class=card-header id=headingage> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#age aria-expanded aria-controls=age onclick="setAnchor('#age')"><span class=property-name>age</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=age class="collapse property-definition-div" aria-labelledby=headingage data-parent=#accordionage> <div class=card-body><span class="badge badge-dark value-type">Type: integer</span> <span class=description><p>Between 1 and 150</p> </span> </div> </div> </div> </div> <div class=accordion id=accordionaddress> <div class=card> <div class=card-header id=headingaddress> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#address aria-expanded aria-controls=address onclick="setAnchor('#address')"><span class=property-name>address</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=address class="collapse property-definition-div" aria-labelledby=headingaddress data-parent=#accordionaddress> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> <span class=description><p>can store anything like streets, zip codes, etc.</p> </span> </div> </div> </div> </div> <div class=accordion id=accordioncity> <div class=card> <div class=card-header id=headingcity> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#city aria-expanded aria-controls=city onclick="setAnchor('#city')"><span class=property-name>city</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=city class="collapse property-definition-div" aria-labelledby=headingcity data-parent=#accordioncity> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> </div> </div> </div> </div> <div class=accordion id=accordioncountry> <div class=card> <div class=card-header id=headingcountry> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#country aria-expanded aria-controls=country onclick="setAnchor('#country')"><span class=property-name>country</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=country class="collapse property-definition-div" aria-labelledby=headingcountry data-parent=#accordioncountry> <div class=card-body><span class="badge badge-dark value-type">Type: string</span> </div> </div> </div> </div> </body> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2020-11-24 at 00:15:47 +0100</p> </footer> </html>