From c3e53ecc0cadde5efaea529d514dd24465e17bf0 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:15:34 -0400 Subject: [PATCH 1/8] specify the release date --- schema/1.2.0/event.schema.json | 2 +- schema/1.2.0/query.request.schema.json | 2 +- schema/1.2.0/query.response.schema.json | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/schema/1.2.0/event.schema.json b/schema/1.2.0/event.schema.json index 8cc2aa5..24439fe 100644 --- a/schema/1.2.0/event.schema.json +++ b/schema/1.2.0/event.schema.json @@ -2,7 +2,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://o19s.github.io/ubi/schema/1.2.0/event.schema.json", "title": "Event tracking for UBI", - "description": "Version 1.2.0; last updated 2024-???. An event that occurred, typically in response to a user.", + "description": "Version 1.2.0; last updated 2024-10-24. An event that occurred, typically in response to a user.", "type": "object", "required": ["action_name", "timestamp"], "properties": { diff --git a/schema/1.2.0/query.request.schema.json b/schema/1.2.0/query.request.schema.json index ca7b402..f26abe9 100644 --- a/schema/1.2.0/query.request.schema.json +++ b/schema/1.2.0/query.request.schema.json @@ -2,7 +2,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://o19s.github.io/ubi/schema/1.2.0/query.request.schema.json", "title": "Query Tracking for UBI", - "description": "Version 1.2.0; last updated 2024-??. A query made by a user should include these attributes for UBI tracking.", + "description": "Version 1.2.0; last updated 2024-10-24. A query made by a user should include these attributes for UBI tracking.", "type": "object", "required": [ "user_query" ], "properties": { diff --git a/schema/1.2.0/query.response.schema.json b/schema/1.2.0/query.response.schema.json index 7831811..c5ac3c9 100644 --- a/schema/1.2.0/query.response.schema.json +++ b/schema/1.2.0/query.response.schema.json @@ -2,7 +2,7 @@ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://o19s.github.io/ubi/schema/1.2.0/query.response.schema.json", "title": "Query Response When Using UBI", - "description": "Version 1.2.0; last updated 2024-??. The response to a query made by a user should support this schema.", + "description": "Version 1.2.0; last updated 2024-10-24. The response to a query made by a user should support this schema.", "type": "object", "required": [ "query_id" ], "properties": { From 02575c5d9c980245565e631ac03cbcf6c8dbf054 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:15:47 -0400 Subject: [PATCH 2/8] Update references --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 5d3b8cd..773968f 100644 --- a/README.md +++ b/README.md @@ -30,8 +30,9 @@ Many Search teams struggle with understanding "Why is my user doing this". They There are A LOT of tools out there for tracking events, Google Analytics, Snowplow, etc, but each is a bit different, and each tends to lock you in. None of them think about the needs of Search teams specifically either. The User Behavior Insights standard attempts to provide a search focused standard that can operate across many platforms. There are implementations for - * [OpenSearch](https://github.com/o19s/documentation-website/tree/ubi-docs-consolidation/_search-plugins/ubi) + * [OpenSearch](https://opensearch.org/docs/latest/search-plugins/ubi) * [Apache Solr](https://github.com/apache/solr/pull/2452) + * [Elasticsearch](https://github.com/o19s/user-behavior-insights-elasticsearch) ## 🪛 How to use it From 5d067a19b0060112a706c9d99b48728d4cadb1c5 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:17:08 -0400 Subject: [PATCH 3/8] bump links --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 773968f..a733e18 100644 --- a/README.md +++ b/README.md @@ -42,9 +42,9 @@ UBI requires coordination between the client (a browser, a mobile app, etc) and | JSON Schema | HTML Docs | | --- | --- | - [query.request.schema.json](https://o19s.github.io/ubi/schema/1.1.0/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/query.request.schema.html) | -| [query.response.schema.json](https://o19s.github.io/ubi/schema/1.1.0/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/query.response.schema.html) | -| [event.schema.json](https://o19s.github.io/ubi/schema/1.1.0/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/1.1.0/event.schema.html) | + [query.request.schema.json](https://o19s.github.io/ubi/schema/1.2.0/query.request.schema.json) | [query.request.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/query.request.schema.html) | +| [query.response.schema.json](https://o19s.github.io/ubi/schema/1.2.0/query.response.schema.json) | [query.response.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/query.response.schema.html) | +| [event.schema.json](https://o19s.github.io/ubi/schema/1.2.0/event.schema.json) | [event.schema.html](https://o19s.github.io/ubi/docs/html/1.2.0/event.schema.html) | You just need to copy, download or reference one of the schema files to validate a UBI data structure, built as a JSON file from scratch, or a JSON generated previously (for example, [these samples](https://github.com/o19s/ubi/blob/master/samples/)). From a73c2523d23c615c6441368e9abc320a8303ed48 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:19:11 -0400 Subject: [PATCH 4/8] reorg finally the 1.0.0 release docs --- docs/html/{ => 1.0.0}/event.schema.html | 0 docs/html/{ => 1.0.0}/query.request.schema.html | 0 docs/html/{ => 1.0.0}/query.response.schema.html | 0 3 files changed, 0 insertions(+), 0 deletions(-) rename docs/html/{ => 1.0.0}/event.schema.html (100%) rename docs/html/{ => 1.0.0}/query.request.schema.html (100%) rename docs/html/{ => 1.0.0}/query.response.schema.html (100%) diff --git a/docs/html/event.schema.html b/docs/html/1.0.0/event.schema.html similarity index 100% rename from docs/html/event.schema.html rename to docs/html/1.0.0/event.schema.html diff --git a/docs/html/query.request.schema.html b/docs/html/1.0.0/query.request.schema.html similarity index 100% rename from docs/html/query.request.schema.html rename to docs/html/1.0.0/query.request.schema.html diff --git a/docs/html/query.response.schema.html b/docs/html/1.0.0/query.response.schema.html similarity index 100% rename from docs/html/query.response.schema.html rename to docs/html/1.0.0/query.response.schema.html From ce78056181053ef625d5cdb225244b22c987a273 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:20:14 -0400 Subject: [PATCH 5/8] no longer using the out dir --- out/event.schema.json | 1 - out/query.request.schema.json | 1 - out/query.response.schema.json | 1 - 3 files changed, 3 deletions(-) delete mode 100644 out/event.schema.json delete mode 100644 out/query.request.schema.json delete mode 100644 out/query.response.schema.json diff --git a/out/event.schema.json b/out/event.schema.json deleted file mode 100644 index c24bcbc..0000000 --- a/out/event.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/event.schema.json","title":"Event tracking for UBI","description":"Version 1.0.0; last updated 2024-06-14. An event that occurred, typically in response to a user.","type":"object","required":["action_name","query_id","timestamp"],"properties":{"application":{"description":"name of the application tracking UBI events.","type":"string","maxLength":100,"examples":["amazon-shop","ABC-microservice","doctor-search"]},"action_name":{"description":"The name of the action that triggered the event. We have a set of common defaults, however you can pass in whatever you want.","oneOf":[{"type":"string","maxLength":100,"enum":["click_through","add_to_cart","click","watch","view","purchase"]},{"type":"string","maxLength":100}]},"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"description":"The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. If only authenticated users are tracked, then you could use a specific user id here, otherwise you should use something permanent and track user id as an _Additional Property_.","type":"string","maxLength":100,"examples":["5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5","quepid-nightly-bot","BugsBunny::Firefox@0967084"]},"timestamp":{"description":"When the event took place.","type":"string","format":"date-time","examples":["2018-11-13T20:20:39+00:00"]},"message_type":{"description":"Group various `action_name`'s into logical bins.","type":"string","maxLength":100,"examples":["QUERY","CONVERSION"],"$comment":"TDB: action_type? event_type? Should the front end even define this?"},"message":{"description":"Optional text message for the log entry. For example, for a message_type of QUERY, we would expect the text to be about what the user is searching on.","type":"string","maxLength":1024},"event_attributes":{"description":"Extensible details about a specific event. A common example of an _Additional Properties_ is the specific identifier of the user (`user_id`). Note: a user identifier is different then the required `client_id` attribute.","type":"object","additionalProperties":true,"required":["position"],"properties":{"object":{"description":"Structure which contains identifying information of the object returned from the query that the user interacts with (i.e.: a book, a product, a post, etc..).","type":"object","additionalProperties":true,"required":["object_id"],"properties":{"object_id":{"description":"The id that a user could look up and find the object instance within the *document corpus*. Examples include: _ssn_, _isbn_, _ean_, etc. Variants need to be incorporated in the `object_id`, so for a t-shirt that is red, you would need SKU level as the `object_id`.","examples":["XYZ-12345","ISBN 0-061-96436-0","123"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100},"internal_id":{"description":"A unique id that the an individual search engine uses internally to index the object via. For example, in OpenSearch, think the `_id` field in the indices.","examples":["1","123456"],"anyOf":[{"type":"string","maxLength":256},{"type":"integer"}]}}},"position":{"description":"Structure that contains information on the location of the event origin, such as screen x,y coordinates, or the nth object out of 10 results.","type":"object","additionalProperties":true,"oneOf":[{"type":"object","properties":{"ordinal":{"description":"The nth position of the document on the search results page.","type":"object","properties":{"index":{"description":"The position of the document. For grid layout this would be left to right, ignoring wrapping.","type":"integer","examples":[1,3,24]}},"required":["index"]}},"required":["ordinal"]},{"type":"object","properties":{"xy":{"description":"The x,y coordinates on the screen for triggering an event.","$comment":"What about bounding boxes?","type":"object","properties":{"x":{"description":"The horizontal location on the page or screen of the event.","type":"number"},"y":{"description":"The vertical location on the page or screen of the event.","type":"number"}},"required":["x","y"]}},"required":["xy"]}]}}}}} diff --git a/out/query.request.schema.json b/out/query.request.schema.json deleted file mode 100644 index ad8f8c7..0000000 --- a/out/query.request.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/query.request.schema.json","title":"Query Tracking for UBI","description":"Version 1.0.0; last updated 2024-06-14. A query made by a user should include these attributes for UBI tracking.","type":"object","required":["user_query"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]},"client_id":{"description":"The client issuing the query. This could be a unique browser, a microservice that performs searches, a crawling bot. If only authenticated users are tracked, then you could use a specific user id here, otherwise you should use something permanent and track user id as an _Additional Property_.","type":"string","maxLength":100,"examples":["5e3b2a1c-8b7d-4f2e-a3d4-c9b2e1f3a4b5","quepid-nightly-bot","BugsBunny::Firefox@0967084"]},"user_query":{"description":"The query as the user entered it. No length limit specified.","type":"string","$comment":"Currently not required to support recommendation systems etc that might not have a user generated query."},"query_attributes":{"description":"Any query modifiers like filter choices or pagination. Other attributes such as experiment identifiers that need to be tracked with the query.","type":"object","additionalProperties":true},"object_id_field":{"description":"The name of the field that has the id of the objects that will be stored in the backend queries data store. So it you have a query for products and want to save the SKUs, then this might be `sku` and if you are querying for people, maybe this is `ssn`. If you do not provide this value then the default primary identifier in your search index will be used. For example `_id` on OpenSearch. ","type":"string","maxLength":100}}} diff --git a/out/query.response.schema.json b/out/query.response.schema.json deleted file mode 100644 index 8034dd8..0000000 --- a/out/query.response.schema.json +++ /dev/null @@ -1 +0,0 @@ -{"$schema":"https://json-schema.org/draft/2020-12/schema","$id":"https://o19s.github.io/ubi/schema/1.0.0/query.response.schema.json","title":"Query Response When Using UBI","description":"Version 1.0.0; last updated 2024-06-14. The response to a query made by a user should support this schema.","type":"object","required":["query_id"],"properties":{"query_id":{"description":"The unique identifier of a query, typically a UUID, but can be any string.","oneOf":[{"type":"string","format":"uuid","examples":["00112233-4455-6677-8899-aabbccddeeff"]},{"type":"string","maxLength":100,"examples":["1234-user-5678"]}]}}} From 264fceb6ac696282dd2b8168249b3f954e07fe07 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:21:00 -0400 Subject: [PATCH 6/8] Remove supporting files --- docs/html/schema_doc.css | 181 ------------------------------------ docs/html/schema_doc.min.js | 1 - 2 files changed, 182 deletions(-) delete mode 100644 docs/html/schema_doc.css delete mode 100644 docs/html/schema_doc.min.js diff --git a/docs/html/schema_doc.css b/docs/html/schema_doc.css deleted file mode 100644 index e1f3a51..0000000 --- a/docs/html/schema_doc.css +++ /dev/null @@ -1,181 +0,0 @@ -body { - font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif; - color: #333; - font-weight: 300; - padding: 40px; -} - -.btn.btn-link { - font-size: 18px; - user-select: text; -} - -.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; - margin-top: 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; -} - -.examples pre { - margin-bottom: 0; -} - -.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 */ diff --git a/docs/html/schema_doc.min.js b/docs/html/schema_doc.min.js deleted file mode 100644 index 17eceaf..0000000 --- a/docs/html/schema_doc.min.js +++ /dev/null @@ -1 +0,0 @@ -$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file From f1851a90d625026c9085deb72bd3e2644ae019d2 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:23:53 -0400 Subject: [PATCH 7/8] Revert "Remove supporting files" This reverts commit 264fceb6ac696282dd2b8168249b3f954e07fe07. --- docs/html/schema_doc.css | 181 ++++++++++++++++++++++++++++++++++++ docs/html/schema_doc.min.js | 1 + 2 files changed, 182 insertions(+) create mode 100644 docs/html/schema_doc.css create mode 100644 docs/html/schema_doc.min.js diff --git a/docs/html/schema_doc.css b/docs/html/schema_doc.css new file mode 100644 index 0000000..e1f3a51 --- /dev/null +++ b/docs/html/schema_doc.css @@ -0,0 +1,181 @@ +body { + font: 16px/1.5em "Overpass", "Open Sans", Helvetica, sans-serif; + color: #333; + font-weight: 300; + padding: 40px; +} + +.btn.btn-link { + font-size: 18px; + user-select: text; +} + +.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; + margin-top: 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; +} + +.examples pre { + margin-bottom: 0; +} + +.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 */ diff --git a/docs/html/schema_doc.min.js b/docs/html/schema_doc.min.js new file mode 100644 index 0000000..17eceaf --- /dev/null +++ b/docs/html/schema_doc.min.js @@ -0,0 +1 @@ +$(document).on("click",'a[href^="#"]',function(event){event.preventDefault();history.pushState({},"",this.href)});function flashElement(elementId){myElement=document.getElementById(elementId);myElement.classList.add("jsfh-animated-property");setTimeout(function(){myElement.classList.remove("jsfh-animated-property")},1e3)}function setAnchor(anchorLinkDestination){history.pushState({},"",anchorLinkDestination)}function anchorOnLoad(){let linkTarget=decodeURIComponent(window.location.hash.split("?")[0].split("&")[0]);if(linkTarget[0]==="#"){linkTarget=linkTarget.substr(1)}if(linkTarget.length>0){anchorLink(linkTarget)}}function anchorLink(linkTarget){const target=$("#"+linkTarget);target.parents().addBack().filter(".collapse:not(.show), .tab-pane, [role='tab']").each(function(index){if($(this).hasClass("collapse")){$(this).collapse("show")}else if($(this).hasClass("tab-pane")){const tabToShow=$("a[href='#"+$(this).attr("id")+"']");if(tabToShow){tabToShow.tab("show")}}else if($(this).attr("role")==="tab"){$(this).tab("show")}});setTimeout(function(){let targetElement=document.getElementById(linkTarget);if(targetElement){targetElement.scrollIntoView({block:"center",behavior:"smooth"});setTimeout(function(){flashElement(linkTarget)},500)}},1e3)} \ No newline at end of file From d0708419262fb46e32e45154ac189dd6e8313645 Mon Sep 17 00:00:00 2001 From: Eric Pugh Date: Thu, 24 Oct 2024 10:25:04 -0400 Subject: [PATCH 8/8] Keep supporting files --- docs/html/{ => 1.0.0}/schema_doc.css | 0 docs/html/{ => 1.0.0}/schema_doc.min.js | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename docs/html/{ => 1.0.0}/schema_doc.css (100%) rename docs/html/{ => 1.0.0}/schema_doc.min.js (100%) diff --git a/docs/html/schema_doc.css b/docs/html/1.0.0/schema_doc.css similarity index 100% rename from docs/html/schema_doc.css rename to docs/html/1.0.0/schema_doc.css diff --git a/docs/html/schema_doc.min.js b/docs/html/1.0.0/schema_doc.min.js similarity index 100% rename from docs/html/schema_doc.min.js rename to docs/html/1.0.0/schema_doc.min.js