Skip to content

Commit

Permalink
deploy: f6ac746
Browse files Browse the repository at this point in the history
  • Loading branch information
@MattiSG
MattiSG committed Jun 20, 2024
1 parent b7ad892 commit 6685362
Show file tree
Hide file tree
Showing 39 changed files with 324 additions and 281 deletions.
4 changes: 2 additions & 2 deletions api/collection/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions api/federation/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!doctype html><html lang=en><head><meta charset=utf-8><title>Open Terms Archive - Federation</title><meta name=description content><meta name=viewport content="width=device-width,initial-scale=1"><link rel=stylesheet href="/css/loader.min.ca92c1a7804f2e7bd9ab5796a635b95c6ec04243851c23aa4845f82931dd4c0c.css" integrity="sha256-ypLBp4BPLnvZq1eWpjW5XG7AQkOFHCOqSEX4KTHdTAw="><link rel=apple-touch-icon sizes=180x180 href=/favicon/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=/favicon/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/favicon/favicon-16x16.png><link rel=manifest href=/favicon/site.webmanifest><link rel=mask-icon href=/favicon/safari-pinned-tab.svg color=#000><meta name=msapplication-TileColor content="#ffffff"><meta name=theme-color content="#ffffff"></head><body><div class="container container__hasNoPaddingY container__hasNoPaddingX container__fluid"><div class="container container__1211 container__flex container__hasNoPaddingX container__hasNoPaddingY"><header class=header><div class=header_logo><a href=https://opentermsarchive.org/en/><div class="logo logo__medium"><svg><use href="#logo"/></svg></div></a></div><div class=header_menus><nav class="headerMenu headerMenu__primary"><ul><li><a href=https://opentermsarchive.org/en/datasets/>Datasets</a></li><li><a href=https://opentermsarchive.org/en/memos/>Memos</a></li><li><a href=/>Documentation</a></li><li><a href=https://opentermsarchive.org/en/impact/>Impact</a></li><li><a href=https://opentermsarchive.org/en/about/>About</a></li></ul></nav><nav class="headerMenu headerMenu__secondary"><div class=languageSwitcher><button class=languageSwitcher_current>
<!doctype html><html lang=en><head><meta charset=utf-8><title>Federation</title><meta name=description content><meta name=viewport content="width=device-width,initial-scale=1"><link rel=stylesheet href="/css/loader.min.ec497ac5595176f384307b2f0b9419cc98391447c9c8f16cf306ed80d0b8af6f.css" integrity="sha256-7El6xVlRdvOEMHsvC5QZzJg5FEfJyPFs8wbtgNC4r28="><link rel=apple-touch-icon sizes=180x180 href=/favicon/apple-touch-icon.png><link rel=icon type=image/png sizes=32x32 href=/favicon/favicon-32x32.png><link rel=icon type=image/png sizes=16x16 href=/favicon/favicon-16x16.png><link rel=manifest href=/favicon/site.webmanifest><link rel=mask-icon href=/favicon/safari-pinned-tab.svg color=#000><meta name=msapplication-TileColor content="#ffffff"><meta name=theme-color content="#ffffff"></head><body><div class="container container__hasNoPaddingY container__hasNoPaddingX container__fluid"><div class="container container__1211 container__flex container__hasNoPaddingX container__hasNoPaddingY"><header class=header><div class=header_logo><a href=https://opentermsarchive.org/en/><div class="logo logo__medium"><svg><use href="#logo"/></svg></div></a></div><div class=header_menus><nav class="headerMenu headerMenu__primary"><ul><li><a href=https://opentermsarchive.org/en/datasets/>Datasets</a></li><li><a href=https://opentermsarchive.org/en/memos/>Memos</a></li><li><a href=/>Documentation</a></li><li><a href=https://opentermsarchive.org/en/impact/>Impact</a></li><li><a href=https://opentermsarchive.org/en/about/>About</a></li></ul></nav><nav class="headerMenu headerMenu__secondary"><div class=languageSwitcher><button class=languageSwitcher_current>
EN<svg class="icon_arrowDown"><use href="#arrowDown"/></svg></button><div class=languageSwitcher_items><div class=languageSwitcher_item><a href=/fr/>FR</a></div></div></div><ul><li><a class=icon_circle target=_blank rel=noopener href=https://mastodon.lescommuns.org/@opentermsarchive><svg class="icon icon--fill-white"><use href="#mastodon"/></svg></a></li><li><a class=icon_circle target=_blank rel=noopener title="View source code" href=https://github.com/OpenTermsArchive><svg class="icon_github"><use href="#github"/></svg></a></li></ul></nav></div><button type=button class=header_openLink>
Menu</button>
<button type=button class=header_closeLink>
Close<svg class="icon_close"><use href="#close"/></svg></button></header></div></div><div class="container container__hasNoPaddingTop"><div class="container container__1211 container__flex container__hasPaddingYSmall"><aside class=aside><nav class=aside_nav><ul class=aside_items><li class=aside_item><a href=/>Getting started</a></li><li class=aside_item><a href=/navigate-history/>Browsing through terms</a></li><li class=aside_item><a href=/subscribe-rss/>Subscribing to terms changes</a></li><li class=aside_item><a href=/contributing-terms/>Contributing terms</a></li><li class=aside_item><span class=aside_item_section>Collections</span><ul class=aside_subitems><li class=aside_subitem><a href=/collections/metadata/>Metadata</a></li><li class=aside_subitem><a href=/collections/governance/>Governance</a></li><li class=aside_subitem><a href=/collections/create/>Creating a collection</a></li><li class=aside_subitem><a href=/collections/federation/>Federation</a><nav id=TableOfContents><ul><li><a href=#benefits>Benefits</a></li><li><a href=#criteria>Criteria</a></li><li><a href=#how-to-join>How to join</a></li><li><a href=#disclaimer>Disclaimer</a></li></ul></nav></li></ul></li><li class="aside_item aside_item-current"><span class=aside_item_section>API</span><ul class=aside_subitems><li class=aside_subitem><a href=/api/node/>Node</a></li><li class=aside_subitem><a href=/api/collection/>Collection</a></li><li class=aside_subitem><a href=/api/federation/>Federation</a><nav id=TableOfContents><ul><li><a href=#beta>Beta</a></li><li><a href=#source-code>Source code</a></li><li><a href=#configuring>Configuring</a></li><li><a href=#deploying>Deploying</a></li></ul></nav></li></ul></li><li class=aside_item><span class=aside_item_section>Guidelines</span><ul class=aside_subitems><li class=aside_subitem><a href=/guidelines/choosing-selectors/>Choosing selectors</a></li><li class=aside_subitem><a href=/guidelines/declaring/>Declaring documents</a></li><li class=aside_subitem><a href=/guidelines/reviewing/>Reviewing contributions</a></li><li class=aside_subitem><a href=/guidelines/targeting/>Targeting</a></li></ul></li><li class=aside_item><a href=/design-principles/>Design principles</a></li><li class=aside_item><span class=aside_item_section>Memos</span><ul class=aside_subitems><li class=aside_subitem><a href=/memos/copywriting-reference/>Copywriting reference</a></li><li class=aside_subitem><a href=/memos/how-to-publish/>How to publish a memo</a></li></ul></li></ul></nav></aside><div class=textContent><h1 id=federation-api>Federation API</h1><p>Open Terms Archive is a decentralised system that tracks collections of services&rsquo; terms across multiple servers. Each collection operates its own API, and the Federation API unifies search and discovery across collections, fostering collaboration with external applications.</p><p>The Federation API exposes JSON data over HTTP. Its <a href=http://162.19.74.224/federation-api/v1/docs/>documentation</a> is provided in a dedicated, interactive interface.</p><p>That endpoint exposes both the <a href=https://swagger.io/specification/>OpenAPI</a> specification if the requested <code>Content-Type</code> is JSON, and a Swagger UI for visual and interactive documentation otherwise.</p><h2 id=beta>Beta</h2><p>This API is offered as a preview, based on a first use case <a href=https://github.com/OpenTermsArchive/engine/issues/1016>defined</a> with partner <a href=https://tosdr.org>ToS;DR</a>. Unexpected problems or missing functionality may arise. Please provide feedback through <a href=https://github.com/OpenTermsArchive/federation-api/issues>issues</a> in the dedicated repository.</p><h2 id=source-code>Source code</h2><p>The codebase for the Federation API is available on <a href=https://github.com/OpenTermsArchive/federation-api><code>github.com/OpenTermsArchive/federation-api</code></a>.</p><h2 id=configuring>Configuring</h2><p>The default configuration can be found in <code>config/default.json</code>. The full reference is given below. In the vast majority of cases, the default values should be sufficient and only the email sending data should be changed.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-js data-lang=js><span class=line><span class=cl><span class=p>{</span>
Close<svg class="icon_close"><use href="#close"/></svg></button></header></div></div><div class="container container__hasNoPaddingTop"><div class="container container__1211 container__flex container__hasPaddingYSmall"><aside class=aside><nav class=aside_nav><ul class=aside_items><li class=aside_item><a href=/>Getting started</a></li><li class=aside_item><span class=aside_item_section>Terms</span><ul class=aside_subitems><li class=aside_subitem><a href=/terms/how-to-navigate-history/>How to navigate history</a></li><li class=aside_subitem><a href=/terms/tracking-new-terms/>Tracking new terms</a></li><li class=aside_subitem><a href=/terms/declarations-maintenance/>Declarations maintenance</a></li><li class=aside_subitem><a href=/terms/reference/>Reference</a></li><li class=aside_subitem><a href=/terms/how-to-add-terms-using-with-the-graphical-contribution-interface/>How to add terms with the graphical contribution interface</a></li><li class=aside_subitem><a href=/terms/how-to-be-notified-of-terms-changes/>How to be notified of terms changes</a></li></ul></li><li class=aside_item><span class=aside_item_section>Collections</span><ul class=aside_subitems><li class=aside_subitem><a href=/collections/metadata/>Metadata</a></li><li class=aside_subitem><a href=/collections/governance/>Governance</a></li><li class=aside_subitem><a href=/collections/create/>Creating a collection</a></li><li class=aside_subitem><a href=/collections/federation/>Federation</a><nav id=TableOfContents><ul><li><a href=#benefits>Benefits</a></li><li><a href=#criteria>Criteria</a></li><li><a href=#how-to-join>How to join</a></li><li><a href=#disclaimer>Disclaimer</a></li></ul></nav></li></ul></li><li class="aside_item aside_item-current"><span class=aside_item_section>API</span><ul class=aside_subitems><li class=aside_subitem><a href=/api/node/>Node</a></li><li class=aside_subitem><a href=/api/collection/>Collection</a></li><li class=aside_subitem><a href=/api/federation/>Federation</a><nav id=TableOfContents><ul><li><a href=#beta>Beta</a></li><li><a href=#source-code>Source code</a></li><li><a href=#configuring>Configuring</a></li><li><a href=#deploying>Deploying</a></li></ul></nav></li></ul></li><li class=aside_item><span class=aside_item_section>Guidelines</span><ul class=aside_subitems><li class=aside_subitem><a href=/guidelines/choosing-selectors/>Choosing selectors</a></li><li class=aside_subitem><a href=/guidelines/declaring/>Declaring documents</a></li><li class=aside_subitem><a href=/guidelines/reviewing/>Reviewing contributions</a></li><li class=aside_subitem><a href=/guidelines/targeting/>Targeting</a></li></ul></li><li class=aside_item><a href=/design-principles/>Design principles</a></li><li class=aside_item><span class=aside_item_section>Memos</span><ul class=aside_subitems><li class=aside_subitem><a href=/memos/copywriting-reference/>Copywriting reference</a></li><li class=aside_subitem><a href=/memos/how-to-publish/>How to publish a memo</a></li></ul></li></ul></nav></aside><div class=textContent><h1 id=federation-api>Federation API</h1><p>Open Terms Archive is a decentralised system that tracks collections of services&rsquo; terms across multiple servers. Each collection operates its own API, and the Federation API unifies search and discovery across collections, fostering collaboration with external applications.</p><p>The Federation API exposes JSON data over HTTP. Its <a href=http://162.19.74.224/federation-api/v1/docs/>documentation</a> is provided in a dedicated, interactive interface.</p><p>That endpoint exposes both the <a href=https://swagger.io/specification/>OpenAPI</a> specification if the requested <code>Content-Type</code> is JSON, and a Swagger UI for visual and interactive documentation otherwise.</p><h2 id=beta>Beta</h2><p>This API is offered as a preview, based on a first use case <a href=https://github.com/OpenTermsArchive/engine/issues/1016>defined</a> with partner <a href=https://tosdr.org>ToS;DR</a>. Unexpected problems or missing functionality may arise. Please provide feedback through <a href=https://github.com/OpenTermsArchive/federation-api/issues>issues</a> in the dedicated repository.</p><h2 id=source-code>Source code</h2><p>The codebase for the Federation API is available on <a href=https://github.com/OpenTermsArchive/federation-api><code>github.com/OpenTermsArchive/federation-api</code></a>.</p><h2 id=configuring>Configuring</h2><p>The default configuration can be found in <code>config/default.json</code>. The full reference is given below. In the vast majority of cases, the default values should be sufficient and only the email sending data should be changed.</p><div class=highlight><pre tabindex=0 class=chroma><code class=language-js data-lang=js><span class=line><span class=cl><span class=p>{</span>
</span></span><span class=line><span class=cl> <span class=s2>&#34;@opentermsarchive/federation-api&#34;</span><span class=o>:</span> <span class=p>{</span>
</span></span><span class=line><span class=cl> <span class=s2>&#34;logger&#34;</span><span class=o>:</span> <span class=p>{</span> <span class=c1>// Logging mechanism to be notified upon error
</span></span></span><span class=line><span class=cl><span class=c1></span> <span class=s2>&#34;smtp&#34;</span><span class=o>:</span> <span class=p>{</span>
Expand Down
Loading

0 comments on commit 6685362

Please sign in to comment.