Skip to content

Commit

Permalink
Module orkestratie aanmaken
Browse files Browse the repository at this point in the history
  • Loading branch information
@fterpstra
fterpstra committed Oct 15, 2024
1 parent 07e13ae commit cdd2058
Show file tree
Hide file tree
Showing 7 changed files with 305 additions and 0 deletions.
17 changes: 17 additions & 0 deletions API-strategie-modules/orchestration/LICENSE
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
The W3C SOFTWARE NOTICE AND LICENSE (W3C)

https://www.w3.org/Consortium/Legal/2015/copyright-software-and-document

This work is being provided by the copyright holders under the following license. By obtaining and/or copying this work, you (the licensee) agree that you have read, understood, and will comply with the following terms and conditions.

Permission to copy, modify, and distribute this work, with or without modification, for any purpose and without fee or royalty is hereby granted, provided that you include the following on ALL copies of the work or portions thereof, including modifications:
1. The full text of this NOTICE in a location viewable to users of the redistributed or derivative work.
2. Any pre-existing intellectual property disclaimers, notices, or terms and conditions. If none exist, the W3C Software and Document Short Notice (https://www.w3.org/Consortium/Legal/2015/copyright-software-short-notice.html) should be included.
3. Notice of any changes or modifications, through a copyright statement on the new code or document such as "This software or document includes material copied from or derived from [title and URI of the W3C document]. Copyright © [YEAR] W3C® (MIT, ERCIM, Keio, Beihang)."


THIS WORK IS PROVIDED "AS IS," AND COPYRIGHT HOLDERS MAKE NO REPRESENTATIONS OR WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO, WARRANTIES OF MERCHANTABILITY OR FITNESS FOR ANY PARTICULAR PURPOSE OR THAT THE USE OF THE SOFTWARE OR DOCUMENT WILL NOT INFRINGE ANY THIRD PARTY PATENTS, COPYRIGHTS, TRADEMARKS OR OTHER RIGHTS.

COPYRIGHT HOLDERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THE SOFTWARE OR DOCUMENT.

The name and trademarks of copyright holders may NOT be used in advertising or publicity pertaining to the work without specific, written prior permission. Title to copyright in this work will at all times remain with copyright holders.
32 changes: 32 additions & 0 deletions API-strategie-modules/orchestration/README.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
## Template document API Strategie Modulen

Deze folder bevat een template om nieuwe modulen te maken. Kopieer de files en pas de inhoud aan om een nieuw Respec document te maken wat de module specificeert.

### Gebruikers instructie
Om aanpassingen te maken zijn er 2 opties:
- De configuratie van het document aanpassing in de config files
- Markdown files toevoegen

De **configuratie files** bevat informatie over de organisatie en over
de status van het document. Bekijk de [Logius ReSpec wiki](https://github.com/Logius-standaarden/respec/wiki)
voor meer informatie over de configuratie opties. De files zijn gesplitst in 2 files:
[organisation-config.js](js/organisation-config.js) en [config.js](js/config.js)

De *organisation_config* bevat informatie over de organisatie, de informatie in deze file
zal bijna nooit veranderen zoals de naam van de organisatie. Het wordt aangeraden de file
zelf te hosten zodat hij in alle documentatie van de organisatie gebruikt kan worden en
niet elke keer gekopieerd te worden.

De *document_config* zal informatie bevatten die alleen relevant is voor het huidige document.

**Markdown files** bevatten de content van het document. Alle content
kan in 1 document, maar het is aan te raden om de content te splitsen
in verschillende files met een toepasselijke naam om onderhoud
makkelijker te maken.

Na het toevoegen van een nieuwe markdown file moet hij toegevoegd worden
aan de [index.html](index.html). Je voegt hem toe door
```<section data-include-format="markdown" data-include="filenaam.md"></section>```
toe te voegen aan de ```<body>``` van de index file. Vervang "filenaam.md" door de naam
van de markdown file die je toe wilt voegen.
De volgorde van de sections bepaald de volgorde in het resulterende document.
2 changes: 2 additions & 0 deletions API-strategie-modules/orchestration/abstract.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
Deze orkestratie module beschrijft deign rules en best practices voor het orkestreren van REST APIs

29 changes: 29 additions & 0 deletions API-strategie-modules/orchestration/index.html
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
<!DOCTYPE html>
<html lang="nl">

<head>
<meta content="text/html; charset=utf-8" http-equiv="content-type">
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
<script src="https://cdn.jsdelivr.net/gh/digitalbazaar/[email protected]/dist/main.js" class="remove"></script>
<script src="https://tools.geostandaarden.nl/respec/config/geonovum-config.js" class="remove"></script>
<script src="js/config.js" class="remove"></script>
<script class="remove"> respecConfig = {...organisationConfig, ...respecConfig}</script>
<script>document.title = respecConfig.title</script>
<!-- titel wordt overschreven door config.js-->
<title>Orchestration</title>
<link rel="shortcut icon" type="image/x-icon" href="https://tools.geostandaarden.nl/respec/style/logos/Geonovum.ico" />
<script src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js" class="remove" async></script>
</head>

<body>
<section id="abstract" data-include-format="markdown" data-include="./abstract.md"></section>
<section id="sotd"></section><!-- Wordt automatisch gevuld -->
<section data-include="../../inleiding.md" data-include-format="markdown" class="informative"></section>
<section data-include="./orchestration.md" data-include-format="markdown"></section>
<!-- Hieronder optionele secties. Worden automatisch gevuld
<section id='conformance'></section>
<section id='tof'></section>
<section id="index"></section> -->
</body>

</html>
82 changes: 82 additions & 0 deletions API-strategie-modules/orchestration/js/config.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
let respecConfig = {
useLogo: true,
useLabel: true,
// title is verplicht! Neem hier de titel van het document op ----------------------
title: "Naming Conventions",
//-- specStatus is verplicht! (activeer 1 van de volgende) --------------------------
specStatus: "wv", // Werkversie
//specStatus: "cv", // Consultatieversie
//specStatus: "vv", // Versie ter vaststelling
//specStatus: "def", // Vastgestelde versie
//specStatus: "basis", // Basis Document
//-- specType is verplicht bij alle andere dan BASIS ---------------------------------
//specType: "NO", // Norm
//specType: "ST", // Standaard
//specType: "IM", // Informatie Model
//specType: "PR", // Praktijkrichtlijn
specType: "HR", // HandReiking
//specType: "WA", // Werkafspraak
//specType: "BD", // Beheer Documentatie
//specType: "AL", // Algemeen document
//specType: "BP", // Best Practice
//-- pubDomain is verplicht! (komt in de URL) -------------------------------------
pubDomain: "api",
//-- license: voor de geldende gebruiksvoorwaarden. Default is cc-by.
//licence: "cc-by-nd", // bronvermelding, geen afgeleide werken (default)
//licence: "cc0", // Public Domain Dedication
licence: "cc-by", // Attribution, met bronvermelding
//-- shortName is verplicht! (komt in de URL: kies logische afkorting)--------------
shortName: "API-Strategie-mod-orchestration",
edDraftURI: "https://geonovum.github.io/KP-APIs/API-strategie-modules/orchestration/",
//edDraftURI = De URI van de draft version. Deze wordt automatisch afgeleid van de github URI; maar kan hier overschreven worden.
//edDraftURI: ["https://geonovum.github.io", "/", "shortName"],

//-- publishDate is verplicht -------------------------------------------------------
//-- NB: in de werkversie uitzetten, want dan pakt Respec de pushdate ---------------
//publishDate: "2023-12-21",
//eventueel is het mogelijk een versienummer mee te geven, maar bij Geonovum werken we gewoonlijk alleen met datum als onderdeel van de permanente URI.
publishVersion: "0.0.1",
//previousVersion: "0.0.1",
//-- Voor dit blok geldt: alleen als er eerdere versies zijn en altijd beiden aan/uit!
//previousPublishDate: "2023-12-21",
//previousMaturity: "vv",
//-- de namen van de Editor(s) / Redacteur(en)---------------------------------------
//-- vul in: per Editor: name:, company:, companyURL: -------------------------------
editors:
[
{
name: "Kennisplatform API's",
company: "Kennisplatform API's",
companyURL: "https://github.com/Geonovum/KP-APIs",
}
],
authors:
[
{
name: "Kennisplatform API's",
company: "Kennisplatform API's",
companyURL: "https://github.com/Geonovum/KP-APIs",
}
],
//neem hier de URL van de github repository op waar het respec document in staat
github: "https://github.com/Geonovum/KP-APIs",
// Controls if linked "§" section markers are added to a document
addSectionLinks: true,

localBiblio: {
"HAL": {
href: "http://stateless.co/hal_specification.html",
title: "HAL - Hypertext Application Language",
authors: ["Mike Kelly"],
date: " 2013-09-18",
},
}

// Create PDF and link to file in header (optional):
//alternateFormats: [
// {
// label: "pdf",
// uri: "template.pdf",
// },
// ],
};
125 changes: 125 additions & 0 deletions API-strategie-modules/orchestration/js/organisation-config.js
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,125 @@
// Dit bestand is gepubliceerd als https://tools.geostandaarden.nl/respec/config/geonovum-config.js, voor hergebruik in Geonovum ReSpec documenten.
var organisationConfig = {
nl_organisationName: "Geonovum",
// werkt nog niet
// nl_organisationStylesURL: "https://tools.geostandaarden.nl/respec/gn-algemeen/style/",
// bv styles url voor ander GN publicatiedomein met eigen stijlen zoals DSO of BRO:
// nl_organisationStylesURL: "https://tools.geostandaarden.nl/respec/dso/style/",
// nl_organisationStylesURL: "https://tools.geostandaarden.nl/respec/bro/style/",
nl_organisationPublishURL: "https://docs.geostandaarden.nl/",
logos: [{
src: "https://tools.geostandaarden.nl/respec/style/logos/Geonovum.svg",
alt: "Geonovum",
id: "Geonovum",
height: 67,
width: 132,
url: "https://www.geonovum.nl/geo-standaarden",
}],

postProcess: [window.respecMermaid.createFigures],

latestVersion: ["nl_organisationPublishURL", "pubDomain", "/", "shortName", "/"],
thisVersion: ["nl_organisationPublishURL", "pubDomain", "/", "specStatus", "-", "specType", "-", "shortName", "-", "publishDate"],
prevVersion: ["nl_organisationPublishURL", "pubDomain", "/", "previousMaturity", "-", "specType", "-", "shortName", "-", "previousPublishDate"],
useLogo: true,
useLabel: true,

license: "cc-by",
addSectionLinks: true,

localizationStrings: {
en: {
wv: "Editor's draft",
cv: "Candidate recommendation",
vv: "Proposed recommendation",
def: "Recommendation",
basis: "Document",
//eo: "Outdated version",
//tg: "Rescinded version",
no: "Norm",
st: "Standard",
im: "Information model",
pr: "Practical guideline",
hr: "Guide",
wa: "Work process agreement",
al: "General",
bd: "Governance documentation",
bp: "Best practice",
},
nl: {
wv: "Werkversie",
cv: "Consultatieversie",
vv: "Versie ter vaststelling",
def: "Vastgestelde versie",
basis: "Document",
//eo: "Verouderde versie",
//tg: "Teruggetrokken versie",
no: "Norm",
st: "Standaard",
im: "Informatiemodel",
pr: "Praktijkrichtlijn",
hr: "Handreiking",
wa: "Werkafspraak",
al: "Algemeen",
bd: "Beheerdocumentatie",
bp: "Best practice",
},
},

sotdText: {
nl: {
sotd: "Status van dit document",
def: `Dit is de definitieve versie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
wv: `Dit is een werkversie die op elk moment kan worden gewijzigd, verwijderd of vervangen door andere documenten. Het is geen stabiel document.`,
cv: `Dit is een consultatieversie. Commentaar over dit document kan gestuurd worden naar `,
vv: `Dit is de definitieve conceptversie van dit document. Wijzigingen naar aanleiding van consultaties zijn doorgevoerd.`,
basis: "Dit is een document zonder officiële status.",
},
en: {
sotd: "Status of this document",
def: `This is the definitive version of this document. Edits resulting from consultations have been applied.`,
wv: `This is a working draft that can be changed, removed or replaced by other documents at any time. It is not a stable document.`,
cv: `This is a stable draft, published for public comment. Comments regarding this document may be sent to `,
vv: `This is the final draft of this document. Edits resulting from consultations have been applied.`,
basis: "This document has no official standing.",
},
},

labelColor: {
def: "#045D9F",
wv: "#FF0000",
cv: "#045D9F",
vv: "#045D9F",
basis: "#80CC28",
},

licenses: {
"cc0": {
name: "Creative Commons 0 Public Domain Dedication",
short: "CC0",
url: "https://creativecommons.org/publicdomain/zero/1.0/",
image: "https://tools.geostandaarden.nl/respec/style/logos/CC-Licentie.svg",
},
"cc-by": {
name: "Creative Commons Attribution 4.0 International Public License",
short: "CC-BY",
url: "https://creativecommons.org/licenses/by/4.0/legalcode",
image: "https://tools.geostandaarden.nl/respec/style/logos/cc-by.svg",
},
"cc-by-nd": {
name: "Creative Commons Naamsvermelding-GeenAfgeleideWerken 4.0 Internationaal",
short: "CC-BY-ND",
url: "https://creativecommons.org/licenses/by-nd/4.0/legalcode.nl",
image: "https://tools.geostandaarden.nl/respec/style/logos/cc-by-nd.svg",
},
},

localBiblio: {
"SemVer": {
href: "https://semver.org",
title: "Semantic Versioning 2.0.0",
authors: ["T. Preston-Werner"],
date: "June 2013"
},
},
}
18 changes: 18 additions & 0 deletions API-strategie-modules/orchestration/orchestration.md
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
## Orchestration
Lorem Ipsum ...

### Batching

Lorem Ipsum ...

<div class="rule" id="/orchestration/example-rule">
<p class="rulelab"><b>/orchestration/example-rule</b>This is an example rule</p>
<p>In case blablabla.</p>
<p class="example">For example, a resource blabla <code>blablabla</code> or <code>blabla</code>.</p>
</div>

### Security
Lorem Ipsum ...

### Architecture & definition
Lorem Ipsum ...

0 comments on commit cdd2058

Please sign in to comment.