Skip to content

Commit

Permalink
new preview build
Browse files Browse the repository at this point in the history
  • Loading branch information
logius-standaardenbeheer committed Jan 24, 2025
1 parent 4cc4aa8 commit a94c745
Show file tree
Hide file tree
Showing 8 changed files with 3,153 additions and 0 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# Readme

This folder used to hold concept information and documents related to the Governance of the API Design Rules Standard.

The governance documentation had been moved to a separate repository located at [https://github.com/Logius-standaarden/ADR-Beheermodel](https://github.com/Logius-standaarden/ADR-Beheermodel) and then superseded by the [API-Standaarden-Beheermodel](https://logius-standaarden.github.io/API-Standaarden-Beheermodel/).

> The final version is published at [https://logius-standaarden.github.io/API-Standaarden-Beheermodel/](https://logius-standaarden.github.io/API-Standaarden-Beheermodel/)

## More information

For more information about het API Standards visit [https://www.logius.nl/diensten/api-standaarden](https://www.logius.nl/diensten/api-standaarden)

395 changes: 395 additions & 0 deletions API-Design-Rules/integreer-transport-security-module/LICENSE

Large diffs are not rendered by default.

2,275 changes: 2,275 additions & 0 deletions API-Design-Rules/integreer-transport-security-module/index.html

Large diffs are not rendered by default.

50 changes: 50 additions & 0 deletions API-Design-Rules/integreer-transport-security-module/js/config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
var respecConfig = {
alternateFormats: [ {
"label" : "pdf",
"uri" : "API-Design-Rules.pdf"
} ],
authors: [
{
"company" : "Het Kadaster",
"companyURL" : "https://www.kadaster.nl",
"name" : "Jasper Roes"
},
{
"company" : "Het Kadaster",
"companyURL" : "https://www.kadaster.nl",
"name" : "Joost Farla"
}
],
editors: [
{
"company" : "Geonovum",
"companyURL" : "https://www.geonovum.nl",
"name" : "Frank Terpstra"
},
{
"company" : "Geonovum",
"companyURL" : "https://www.geonovum.nl",
"name" : "Jan van Gelder"
},
{
"company" : "Logius",
"companyURL" : "https://www.logius.nl",
"name" : "Alexander Green"
},
{
"company" : "Logius",
"companyURL" : "https://www.logius.nl",
"name" : "Martin van der Plas"
}
],
github: "https://github.com/Logius-standaarden/API-Design-Rules",
pubDomain: "api",
publishDate: "2025-01-07",
publishVersion: "2.0.1",
previousPublishDate: "2024-03-07",
previousPublishVersion: "2.0.0",
shortName: "adr",
specStatus: "WV",
specType: "ST",
pluralize: true,
};
46 changes: 46 additions & 0 deletions API-Design-Rules/integreer-transport-security-module/js/rules.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
$(window).bind('load', function() {
console.log($(".rule").length);
var functionalList = [];
var technicalList = [];

function rules() {
$(".rule").each(function() {
id = this.id;
//console.log(this.id);
var titel = $(this).find(".rulelab")
titel.prepend('<a href="#' + id + '">' + id + '</a>: ');
let implications = "Unknown rule type in " + this.id;
let flag = implications;
let type = $(this).data("type");
if (type == "functional") {
implications = "Adherence to this rule needs to be manually verified.";
flag = "<div title=\"This is a functional design rule and hence cannot be tested automatically.\" class=\"flag\">functional</div>"
functionalList.push(titel.html())
} else if (type == "technical") {
implications = "This rule is included in the automatic tests on <a href=\"https://developer.overheid.nl/\">developer.overheid.nl</a>. The source code of the technical test can be found <a href=\"https://gitlab.com/commonground/don/adr-validator/-/blob/main/pkg/adr/rules.go\">here</a>.";
flag = "<div title=\"This is a technical design rule and hence should be tested automatically.\" class=\"flag\">technical</div>"
technicalList.push(titel.html())
} else {
//throw new Error(implications);
}
$(this).prepend(flag);
$(this).find("#implications").append(implications).removeAttr('id');
});
compileList(functionalList, "#functionalList");
compileList(technicalList, "#technicalList");
};

function compileList(list, id) {
var target = $(id)

$.each(list, function(index, val) {
target.append("<li>" + val + "</li>");
});
}

if ($(".rule").length > 0) {
rules();
} else {
window.setTimeout(rules, 500);
}
});
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
/*-- Design rule block ------------------------------------------------------------*/
.rule {
margin: 1em 0;
padding: 1em 2em;
border-left-width: 0.5em;
border-left-style: solid;
border-color: #8CCBF2;
background: rgb(241, 246, 253);
}

.rulelab {
color: #005A9C;
}

.rulelab a {
font-weight: bold;
}

.flag {
float: right;
text-decoration: underline dotted;
text-transform: capitalize;
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# publishers.yml This is a list of organizations and repositories to crawl.

---

- name: "Logius"
id: "Logius"
kvk: "27381312"
oin: "00000004003214345001"
orgs:
- "https://github.com/Logius-standaarden"
- "https://gitlab.com/logius"
repos:
- "https://github.com/Logius-standaarden/API-Design-Rules"
- "https://github.com/Logius-standaarden/OAuth-NL-profiel"
- "https://github.com/Logius-standaarden/Digikoppeling-Algemeen"
- "https://gitlab.com/logius/digikoppeling-compliance"

apis:
- "https://portaal.digikoppeling.nl/registers/api/v1/"
- "https://cparegister.nl/api/v1"

0 comments on commit a94c745

Please sign in to comment.