-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Deployed a0010fd with MkDocs version: 1.6.1
- Loading branch information
Unknown
committed
Jan 16, 2025
1 parent
9536fad
commit 6919f6b
Showing
33 changed files
with
5,669 additions
and
848 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,384 @@ | ||
|
||
<!DOCTYPE html> | ||
|
||
<html class="no-js" lang="en"> | ||
<head> | ||
<meta charset="utf-8"/> | ||
<meta content="width=device-width,initial-scale=1" name="viewport"/> | ||
<link href="https://nfdi4cat.github.io/pid4cat-model/HandleAPIRecord/" rel="canonical"/> | ||
<link href="../images/favicon.svg" rel="icon"/> | ||
<meta content="mkdocs-1.6.1, mkdocs-material-8.5.10" name="generator"/> | ||
<title>Class: HandleAPIRecord - pid4cat-model</title> | ||
<link href="../assets/stylesheets/main.975780f9.min.css" rel="stylesheet"/> | ||
<link href="../assets/stylesheets/palette.2505c338.min.css" rel="stylesheet"/> | ||
<link crossorigin="" href="https://fonts.gstatic.com" rel="preconnect"/> | ||
<link href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" rel="stylesheet"/> | ||
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style> | ||
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce((e,_)=>(e<<5)-e+_.charCodeAt(0),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script> | ||
</head> | ||
<body data-md-color-accent="None" data-md-color-primary="None" data-md-color-scheme="default" dir="ltr"> | ||
<input autocomplete="off" class="md-toggle" data-md-toggle="drawer" id="__drawer" type="checkbox"/> | ||
<input autocomplete="off" class="md-toggle" data-md-toggle="search" id="__search" type="checkbox"/> | ||
<label class="md-overlay" for="__drawer"></label> | ||
<div data-md-component="skip"> | ||
<a class="md-skip" href="#class-handleapirecord"> | ||
Skip to content | ||
</a> | ||
</div> | ||
<div data-md-component="announce"> | ||
</div> | ||
<header class="md-header" data-md-component="header"> | ||
<nav aria-label="Header" class="md-header__inner md-grid"> | ||
<a aria-label="pid4cat-model" class="md-header__button md-logo" data-md-component="logo" href=".." title="pid4cat-model"> | ||
<img alt="logo" src="../images/logo-icon.svg"/> | ||
</a> | ||
<label class="md-header__button md-icon" for="__drawer"> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"></path></svg> | ||
</label> | ||
<div class="md-header__title" data-md-component="header-title"> | ||
<div class="md-header__ellipsis"> | ||
<div class="md-header__topic"> | ||
<span class="md-ellipsis"> | ||
pid4cat-model | ||
</span> | ||
</div> | ||
<div class="md-header__topic" data-md-component="header-topic"> | ||
<span class="md-ellipsis"> | ||
|
||
Class: HandleAPIRecord | ||
|
||
</span> | ||
</div> | ||
</div> | ||
</div> | ||
<label class="md-header__button md-icon" for="__search"> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path></svg> | ||
</label> | ||
<div class="md-search" data-md-component="search" role="dialog"> | ||
<label class="md-search__overlay" for="__search"></label> | ||
<div class="md-search__inner" role="search"> | ||
<form class="md-search__form" name="search"> | ||
<input aria-label="Search" autocapitalize="off" autocomplete="off" autocorrect="off" class="md-search__input" data-md-component="search-query" name="query" placeholder="Search" required="" spellcheck="false" type="text"/> | ||
<label class="md-search__icon md-icon" for="__search"> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.516 6.516 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5Z"></path></svg> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z"></path></svg> | ||
</label> | ||
<nav aria-label="Search" class="md-search__options"> | ||
<button aria-label="Clear" class="md-search__icon md-icon" tabindex="-1" title="Clear" type="reset"> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"></path></svg> | ||
</button> | ||
</nav> | ||
</form> | ||
<div class="md-search__output"> | ||
<div class="md-search__scrollwrap" data-md-scrollfix=""> | ||
<div class="md-search-result" data-md-component="search-result"> | ||
<div class="md-search-result__meta"> | ||
Initializing search | ||
</div> | ||
<ol class="md-search-result__list"></ol> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="md-header__source"> | ||
<a class="md-source" data-md-component="source" href="https://github.com/nfdi4cat/pid4cat-model" title="Go to repository"> | ||
<div class="md-source__icon md-icon"> | ||
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></svg> | ||
</div> | ||
<div class="md-source__repository"> | ||
GitHub | ||
</div> | ||
</a> | ||
</div> | ||
</nav> | ||
</header> | ||
<div class="md-container" data-md-component="container"> | ||
<main class="md-main" data-md-component="main"> | ||
<div class="md-main__inner md-grid"> | ||
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation"> | ||
<div class="md-sidebar__scrollwrap"> | ||
<div class="md-sidebar__inner"> | ||
<nav aria-label="Navigation" class="md-nav md-nav--primary" data-md-level="0"> | ||
<label class="md-nav__title" for="__drawer"> | ||
<a aria-label="pid4cat-model" class="md-nav__button md-logo" data-md-component="logo" href=".." title="pid4cat-model"> | ||
<img alt="logo" src="../images/logo-icon.svg"/> | ||
</a> | ||
pid4cat-model | ||
</label> | ||
<div class="md-nav__source"> | ||
<a class="md-source" data-md-component="source" href="https://github.com/nfdi4cat/pid4cat-model" title="Go to repository"> | ||
<div class="md-source__icon md-icon"> | ||
<svg viewbox="0 0 448 512" xmlns="http://www.w3.org/2000/svg"><!--! Font Awesome Free 6.2.1 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2022 Fonticons, Inc.--><path d="M439.55 236.05 244 40.45a28.87 28.87 0 0 0-40.81 0l-40.66 40.63 51.52 51.52c27.06-9.14 52.68 16.77 43.39 43.68l49.66 49.66c34.23-11.8 61.18 31 35.47 56.69-26.49 26.49-70.21-2.87-56-37.34L240.22 199v121.85c25.3 12.54 22.26 41.85 9.08 55a34.34 34.34 0 0 1-48.55 0c-17.57-17.6-11.07-46.91 11.25-56v-123c-20.8-8.51-24.6-30.74-18.64-45L142.57 101 8.45 235.14a28.86 28.86 0 0 0 0 40.81l195.61 195.6a28.86 28.86 0 0 0 40.8 0l194.69-194.69a28.86 28.86 0 0 0 0-40.81z"></path></svg> | ||
</div> | ||
<div class="md-source__repository"> | ||
GitHub | ||
</div> | ||
</a> | ||
</div> | ||
<ul class="md-nav__list" data-md-scrollfix=""> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href=".."> | ||
Index | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="../principles/"> | ||
Principles | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="../about/"> | ||
About | ||
</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc"> | ||
<div class="md-sidebar__scrollwrap"> | ||
<div class="md-sidebar__inner"> | ||
<nav aria-label="Table of contents" class="md-nav md-nav--secondary"> | ||
<label class="md-nav__title" for="__toc"> | ||
<span class="md-nav__icon md-icon"></span> | ||
Table of contents | ||
</label> | ||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix=""> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#slots"> | ||
Slots | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#usages"> | ||
Usages | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#identifier-and-mapping-information"> | ||
Identifier and Mapping Information | ||
</a> | ||
<nav aria-label="Identifier and Mapping Information" class="md-nav"> | ||
<ul class="md-nav__list"> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#schema-source"> | ||
Schema Source | ||
</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#mappings"> | ||
Mappings | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#linkml-source"> | ||
LinkML Source | ||
</a> | ||
<nav aria-label="LinkML Source" class="md-nav"> | ||
<ul class="md-nav__list"> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#direct"> | ||
Direct | ||
</a> | ||
</li> | ||
<li class="md-nav__item"> | ||
<a class="md-nav__link" href="#induced"> | ||
Induced | ||
</a> | ||
</li> | ||
</ul> | ||
</nav> | ||
</li> | ||
</ul> | ||
</nav> | ||
</div> | ||
</div> | ||
</div> | ||
<div class="md-content" data-md-component="content"> | ||
<article class="md-content__inner md-typeset"> | ||
<a class="md-content__button md-icon" href="https://github.com/nfdi4cat/pid4cat-model/edit/master/docs/HandleAPIRecord.md" title="Edit this page"> | ||
<svg viewbox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><path d="M20.71 7.04c.39-.39.39-1.04 0-1.41l-2.34-2.34c-.37-.39-1.02-.39-1.41 0l-1.84 1.83 3.75 3.75M3 17.25V21h3.75L17.81 9.93l-3.75-3.75L3 17.25Z"></path></svg> | ||
</a> | ||
<h1 id="class-handleapirecord">Class: HandleAPIRecord</h1> | ||
<p><em>A handle record for a PID4CatRecord.</em></p> | ||
<p>URI: <a href="https://w3id.org/nfdi4cat/pid4cat-model/HandleAPIRecord">pid4cat_model:HandleAPIRecord</a></p> | ||
<div class="mermaid"> classDiagram | ||
class HandleAPIRecord | ||
click HandleAPIRecord href "../HandleAPIRecord" | ||
HandleAPIRecord : handle | ||
|
||
HandleAPIRecord : response_code | ||
|
||
HandleAPIRecord : values | ||
|
||
|
||
|
||
|
||
HandleAPIRecord --> "*" HandleRecord : values | ||
click HandleRecord href "../HandleRecord" | ||
|
||
|
||
|
||
</div> | ||
<!-- no inheritance hierarchy --> | ||
<h2 id="slots">Slots</h2> | ||
<table> | ||
<thead> | ||
<tr> | ||
<th>Name</th> | ||
<th>Cardinality and Range</th> | ||
<th>Description</th> | ||
<th>Inheritance</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><a href="../response_code/">response_code</a></td> | ||
<td>0..1 <br/> <a href="../Integer/">Integer</a></td> | ||
<td>The response code of the handle API</td> | ||
<td>direct</td> | ||
</tr> | ||
<tr> | ||
<td><a href="../handle/">handle</a></td> | ||
<td>0..1 <br/> <a href="../String/">String</a></td> | ||
<td>The handle of the PID4CatRecord</td> | ||
<td>direct</td> | ||
</tr> | ||
<tr> | ||
<td><a href="../values/">values</a></td> | ||
<td>* <br/> <a href="../HandleRecord/">HandleRecord</a></td> | ||
<td>The values of the PID4CatRecord</td> | ||
<td>direct</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<h2 id="usages">Usages</h2> | ||
<table> | ||
<thead> | ||
<tr> | ||
<th>used by</th> | ||
<th>used in</th> | ||
<th>type</th> | ||
<th>used</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><a href="../HandleRecordContainer/">HandleRecordContainer</a></td> | ||
<td><a href="../contains_pids/">contains_pids</a></td> | ||
<td>range</td> | ||
<td><a href="./">HandleAPIRecord</a></td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<h2 id="identifier-and-mapping-information">Identifier and Mapping Information</h2> | ||
<h3 id="schema-source">Schema Source</h3> | ||
<ul> | ||
<li>from schema: https://w3id.org/nfdi4cat/pid4cat-model</li> | ||
</ul> | ||
<h2 id="mappings">Mappings</h2> | ||
<table> | ||
<thead> | ||
<tr> | ||
<th>Mapping Type</th> | ||
<th>Mapped Value</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td>self</td> | ||
<td>pid4cat_model:HandleAPIRecord</td> | ||
</tr> | ||
<tr> | ||
<td>native</td> | ||
<td>pid4cat_model:HandleAPIRecord</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
<h2 id="linkml-source">LinkML Source</h2> | ||
<!-- TODO: investigate https://stackoverflow.com/questions/37606292/how-to-create-tabbed-code-blocks-in-mkdocs-or-sphinx --> | ||
<h3 id="direct">Direct</h3> | ||
<details> | ||
<pre><code class="language-yaml">name: HandleAPIRecord | ||
description: A handle record for a PID4CatRecord. | ||
from_schema: https://w3id.org/nfdi4cat/pid4cat-model | ||
slots: | ||
- response_code | ||
- handle | ||
- values | ||
|
||
</code></pre> | ||
</details> | ||
<h3 id="induced">Induced</h3> | ||
<details> | ||
<pre><code class="language-yaml">name: HandleAPIRecord | ||
description: A handle record for a PID4CatRecord. | ||
from_schema: https://w3id.org/nfdi4cat/pid4cat-model | ||
attributes: | ||
response_code: | ||
name: response_code | ||
description: The response code of the handle API. | ||
from_schema: https://w3id.org/nfdi4cat/pid4cat-model | ||
rank: 1000 | ||
alias: responseCode | ||
owner: HandleAPIRecord | ||
domain_of: | ||
- HandleAPIRecord | ||
range: integer | ||
handle: | ||
name: handle | ||
description: The handle of the PID4CatRecord. | ||
from_schema: https://w3id.org/nfdi4cat/pid4cat-model | ||
rank: 1000 | ||
alias: handle | ||
owner: HandleAPIRecord | ||
domain_of: | ||
- HandleAPIRecord | ||
range: string | ||
values: | ||
name: values | ||
description: The values of the PID4CatRecord. | ||
from_schema: https://w3id.org/nfdi4cat/pid4cat-model | ||
rank: 1000 | ||
alias: values | ||
owner: HandleAPIRecord | ||
domain_of: | ||
- HandleAPIRecord | ||
range: HandleRecord | ||
multivalued: true | ||
|
||
</code></pre> | ||
</details> | ||
</article> | ||
</div> | ||
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var tab,labels=set.querySelector(".tabbed-labels");for(tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script> | ||
</div> | ||
</main> | ||
<footer class="md-footer"> | ||
<div class="md-footer-meta md-typeset"> | ||
<div class="md-footer-meta__inner md-grid"> | ||
<div class="md-copyright"> | ||
|
||
|
||
Made with | ||
<a href="https://squidfunk.github.io/mkdocs-material/" rel="noopener" target="_blank"> | ||
Material for MkDocs | ||
</a> | ||
</div> | ||
</div> | ||
</div> | ||
</footer> | ||
</div> | ||
<div class="md-dialog" data-md-component="dialog"> | ||
<div class="md-dialog__inner md-typeset"></div> | ||
</div> | ||
<script id="__config" type="application/json">{"base": "..", "features": ["content.tabs.link"], "search": "../assets/javascripts/workers/search.16e2a7d4.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.config.lang": "en", "search.config.pipeline": "trimmer, stopWordFilter", "search.config.separator": "[\\s\\-]+", "search.placeholder": "Search", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version.title": "Select version"}}</script> | ||
<script src="../assets/javascripts/bundle.5a2dcb6a.min.js"></script> | ||
<script type="module">import mermaid from "https://unpkg.com/[email protected]/dist/mermaid.esm.min.mjs"; | ||
mermaid.initialize({});</script></body> | ||
</html> |
Oops, something went wrong.