Skip to content

Commit

Permalink
Add in application examples
Browse files Browse the repository at this point in the history
epugh committed Oct 23, 2024

Verified

This commit was signed with the committer’s verified signature.
epugh Eric Pugh
1 parent 5057555 commit 0da5e0c
Showing 5 changed files with 29 additions and 8 deletions.
10 changes: 6 additions & 4 deletions docs/html/1.2.0/event.schema.html

Large diffs are not rendered by default.

9 changes: 7 additions & 2 deletions docs/html/1.2.0/query.request.schema.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/html/1.2.0/query.response.schema.html
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
<!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><link rel=stylesheet type=text/css href=schema_doc.css><script src=https://use.fontawesome.com/facf9fa52c.js></script><script src=schema_doc.min.js></script><meta charset=utf-8><title>Query Response When Using UBI</title></head> <body onload=anchorOnLoad(); id=root><div class=text-right> <button class="btn btn-primary" type=button data-toggle=collapse data-target=.collapse:not(.show) aria-expanded=false>Expand all</button> <button class="btn btn-primary" type=button data-toggle=collapse data-target=.collapse.show aria-expanded=false>Collapse all</button> </div> <div class=breadcrumbs></div> <h1>Query Response When Using UBI</h1><span class="badge badge-dark value-type">Type: object</span><br> <span class=description><p>Version 1.2.0; last updated 2024-??. The response to a query made by a user should support this schema.</p> </span> <div class=accordion id=accordionquery_id> <div class=card> <div class=card-header id=headingquery_id> <h2 class=mb-0> <button class="btn btn-link property-name-button" type=button data-toggle=collapse data-target=#query_id aria-expanded aria-controls=query_id onclick="setAnchor('#query_id')"><span class=property-name>query_id</span> <span class="badge badge-warning required-property">Required</span></button> </h2> </div> <div id=query_id class="collapse property-definition-div" aria-labelledby=headingquery_id data-parent=#accordionquery_id> <div class="card-body pl-5"> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id onclick="anchorLink('query_id')">query_id</a></div><br> <span class=description><p>The unique identifier of a query, typically a UUID, but can be any string.</p> </span><div class=one-of-value id=query_id_oneOf><h2 class=handle> <label>One of</label> </h2><ul class="nav nav-tabs" id=tabsquery_id_oneOf_oneOf role=tablist><li class=nav-item> <a class="nav-link active oneOf-option" id=query_id_oneOf_i0 data-toggle=tab href=#tab-pane_query_id_oneOf_i0 role=tab onclick="setAnchor('#query_id_oneOf_i0')">Option 1</a> </li><li class=nav-item> <a class="nav-link oneOf-option" id=query_id_oneOf_i1 data-toggle=tab href=#tab-pane_query_id_oneOf_i1 role=tab onclick="setAnchor('#query_id_oneOf_i1')">Option 2</a> </li></ul> <div class="tab-content card"><div class="tab-pane fade card-body active show" id=tab-pane_query_id_oneOf_i0 role=tabpanel> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id onclick="anchorLink('query_id')">query_id</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id_oneOf onclick="anchorLink('query_id_oneOf')">oneOf</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id_oneOf_i0 onclick="anchorLink('query_id_oneOf_i0')">item 0</a></div><span class="badge badge-dark value-type">Type: string</span><span class="badge badge-info value-type">Format: uuid</span><br> <br> <div class="badge badge-secondary">Example:</div> <br><div id=query_id_oneOf_i0_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;00112233-4455-6677-8899-aabbccddeeff&quot;</span>
</pre></div> </div> </div><div class="tab-pane fade card-body " id=tab-pane_query_id_oneOf_i1 role=tabpanel> <div class=breadcrumbs>root <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id onclick="anchorLink('query_id')">query_id</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id_oneOf onclick="anchorLink('query_id_oneOf')">oneOf</a> <svg width=1em height=1em viewbox="0 0 16 16" class="bi bi-arrow-right-short" fill=currentColor xmlns=http://www.w3.org/2000/svg> <path fill-rule=evenodd d="M4 8a.5.5 0 0 1 .5-.5h5.793L8.146 5.354a.5.5 0 1 1 .708-.708l3 3a.5.5 0 0 1 0 .708l-3 3a.5.5 0 0 1-.708-.708L10.293 8.5H4.5A.5.5 0 0 1 4 8z"/> </svg> <a href=#query_id_oneOf_i1 onclick="anchorLink('query_id_oneOf_i1')">item 1</a></div><span class="badge badge-dark value-type">Type: string</span><br> <p><span class="badge badge-light restriction max-length-restriction" id=query_id_oneOf_i1_maxLength>Must be at most <code>100</code> characters long</span></p> <br> <div class="badge badge-secondary">Example:</div> <br><div id=query_id_oneOf_i1_ex1 class="jumbotron examples"><div class=highlight><pre><span></span><span class=s2>&quot;1234-user-5678&quot;</span>
</pre></div> </div> </div></div></div> </div> </div> </div> </div> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2024-10-23 at 10:12:02 -0400</p> </footer></body> </html>
</pre></div> </div> </div></div></div> </div> </div> </div> </div> <footer> <p class=generated-by-footer>Generated using <a href=https://github.com/coveooss/json-schema-for-humans>json-schema-for-humans</a> on 2024-10-23 at 13:27:45 -0400</p> </footer></body> </html>
4 changes: 3 additions & 1 deletion schema/1.2.0/event.schema.json
Original file line number Diff line number Diff line change
@@ -7,10 +7,12 @@
"required": ["action_name", "timestamp"],
"properties": {
"application": {
"description": "name of the application tracking UBI events.",
"description": "Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have `type-ahead` and `primary-search` as values.",
"type": "string",
"maxLength": 100,
"examples": [
"type-ahead",
"primary-search",
"amazon-shop",
"ABC-microservice",
"doctor-search"
12 changes: 12 additions & 0 deletions schema/1.2.0/query.request.schema.json
Original file line number Diff line number Diff line change
@@ -6,6 +6,18 @@
"type": "object",
"required": [ "user_query" ],
"properties": {
"application": {
"description": "Name of the application that is integrated with UBI. You can think of application as in a source of search queries. For example, if you have a type ahead and a traditional search UI, then you might have `type-ahead` and `primary-search` as values.",
"type": "string",
"maxLength": 100,
"examples": [
"type-ahead",
"primary-search",
"amazon-shop",
"ABC-microservice",
"doctor-search"
]
},
"query_id": {
"description": "The unique identifier of a query, typically a UUID, but can be any string.",
"oneOf": [

0 comments on commit 0da5e0c

Please sign in to comment.