Skip to content

Commit

Permalink
Add Accreditation documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
fabian committed May 21, 2024
1 parent 6e0a30f commit 7ba3b40
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 0 deletions.
1 change: 1 addition & 0 deletions _includes/nav.html
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
<li><a href="/api/conferences/">Conferences</a></li>
<li><a href="/api/org/">Organizations</a></li>
<li><a href="/api/people/">People</a></li>
<li><a href="/api/accreditation">Accreditation</a></li>
</ul></li>
<li{% if page.url contains "/guidelines/" %} class="active"{% endif %}><a href="/guidelines/">Guidelines</a></li>
</ul>
Expand Down
50 changes: 50 additions & 0 deletions api/accreditation.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
layout: api
title: Accreditation API
breadcrumb: Accreditation
api_docs: https://api.worldskills.org/accreditation/swagger.json
---

<div class="page-header">
<h1>Accreditation <small>WorldSkills API</small></h1>
</div>

<div class="row">
<div class="col-md-3 sidebar" role="navigation">

<ul class="list-unstyled" data-spy="affix"
data-offset-top="264">
<li class="active"><a href="#description">Description</a></li>
</ul>

</div>
<div class="col-md-9" id="description">

<div class="row">
<div class="col-md-6">
<h2 id="responsibilities">Responsibilities</h2>
<p>This API is responsible for managing accreditation data for a WorldSkills event.</p>

<h2>Authentication</h2>
<p>If the resource requires authorization, a Bearer access token needs to be sent with the Authorization header:</p>
<pre><code>GET /accreditation HTTP/1.1
Authorization: Bearer ABCD-EFGH-1234-5678</code></pre>
</div>
<div class="col-md-6">
<h2 id="key-concepts">Key Concepts</h2>

<p>Zones define certain areas or services to which people can have access to. An accreditation can have multiple zones.</p>

<p>Delegate types are used to categorize People - each delegate type has a certain color and default zones. A delegate type might be called "sub-category" in the accreditation matrix.</p>


</div>
</div>

<hr />

<div id="api">
<p>Loading API reference…</p>
</div>
</div>
</div>
1 change: 1 addition & 0 deletions api/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,5 @@ <h2>API Reference</h2>
<li><a href="/api/conferences">Conferences</a> Sessions, Speakers</li>
<li><a href="/api/org">Organizations</a> Members</li>
<li><a href="/api/people">People</a> Competitors, Experts</li>
<li><a href="/api/accreditation">Accreditation</a></li>
</ul>

0 comments on commit 7ba3b40

Please sign in to comment.