Formaat Logius Standaarden

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+  - name: Kennisplatform APIs Issue base
+    url: https://github.com/Geonovum/KP-APIs/issues/
+    about: Please submit issues here.

.github/workflows/build.yml

@@ -0,0 +1,20 @@
+name: Build and Check
+on:
+  workflow_dispatch:
+  pull_request:
+  push:
+    branches:
+      - main
+jobs:
+  build:
+    name: Build
+    uses: Logius-standaarden/Automatisering/.github/workflows/build.yml@main
+  check:
+    needs: build
+    name: Check
+    uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main    
+  publish:
+    needs: build
+    name: Publish (Logius)
+    uses: Logius-standaarden/Automatisering/.github/workflows/publish.yml@main
+    secrets: inherit

.gitignore

@@ -0,0 +1,9 @@
+__pycache__
+*.sqlite3
+*.code-workspace
+.vscode
+.DS_Store
+*_log
+*.bkp
+*.dtmp
+Thumbs.db

README.md

@@ -0,0 +1,17 @@
+# API Design Rules Module: Transport Security
+
+## Deze handreiking
+
+### Publicatieversie
+
+https://gitdocumentatie.logius.nl/publicatie/api/mod-geo
+
+### Werkversie
+
+https://logius-standaarden.github.io/API-mod-geospatial/
+
+## Issues
+
+Issues mogen bij het Kennisplatform API's worden ingediend.
+
+https://github.com/Geonovum/KP-APIs/issues

appendix.md

@@ -1,4 +1,4 @@
-# Appendix - deprecated rules
+# Deprecated rules
 This appendix contains some of the rules that were described in the [first version](https://docs.geostandaarden.nl/api/API-Strategie-ext/#geospatial) of the "Geospatial Extension", which was never officially adopted as a standard. Only those rules that are still relevant in some situations or do not have a good replacement in the current Geospatial model are retained here. They are shown here only as information. 
 
 ## POST endpoint for geospatial queries
@@ -10,7 +10,7 @@ What follows is the original description of the rules in the old Geospatial Exte
 
 A spatial filter can be complex and large. It is best practice to supply complex queries in the body, not in the request URI. Since `GET` may not have a payload (although supported by some clients) use a `POST` request to a separate endpoint. For example, a GEO query to all *panden* where the geometry in the field `_geo` (there may be multiple geometry fields) contains a GeoJSON object (in this case a `Point`, so one coordinate pair):
 
-<a name="api-36"></a>
+<span name="api-36"></span>
 <p class="rulelab"><strong>Deprecated rule (was: API-36)</strong>: Provide a <code>POST</code> endpoint for geo queries</p>
 
 Spatial queries are sent in a `POST` to a dedicated endpoint.
@@ -28,7 +28,7 @@ Spatial queries are sent in a `POST` to a dedicated endpoint.
 
 Other geospatial operators like `intersects` or `within` can be used as well.
 
-<a name="api-37"></a>
+<span name="api-37"></span>
 <p class="rulelab"><strong>Deprecated rule (was: API-37)</strong>: Support mixed queries at <code>POST</code> endpoints</p>
 
 The `POST` endpoint is preferably set up as a generic query endpoint to support combined queries:
@@ -55,7 +55,7 @@ If a client specifies CRS using a parameter AND in the header, the parameter tak
 What follows is the original description of the rule in the old Geospatial Extension. 
 </aside>
 
-<a name="api-40"></a>
+<span name="api-40"></span>
 <p class="rulelab"><strong>Deprecated rule (was: API-40)</strong>: Pass the coordinate reference system (CRS) of the request and the response in the headers</p>
 
 The coordinate reference system (CRS) for both the request and the response are passed as part of the request headers and response headers. In case this header is missing, send the HTTP status code `412 Precondition Failed`.

crs.md

@@ -89,7 +89,7 @@ The *default* CRS, i.e. the CRS which is assumed when not specified by either th
 
 In addition, support for ETRS89 and/or RD is required. 
 
-<a name="api-39"></a>
+<span name="api-39"></span>
 <div class="rule" id="/geo/preferred-crs">
   <p class="rulelab"><b>/geo/preferred-crs</b>: Use ETRS89 and/or RD when required, as these are the preferred coordinate reference systems (CRS) for Dutch geospatial data. Follow the Dutch Guideline for the use of CRSs [[hr-crs]].</p>
   <p>General usage of the European ETRS89 coordinate reference system (CRS) or RDNAP is preferred, but is not the default CRS. Hence, one of these CRSs has to be explicitly included in each request when one of these CRSs is desired in the response or used in a request.</p>

index.html

@@ -1,44 +1,30 @@
 <!DOCTYPE html>
 <html lang='en'>
-  <!-- HTML-Header ============================================================================== -->
-  <head>
+
+<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">
-    <!-- Invullen: de titel van de standaard of het document ==================================== -->
-    <title>API Design rules Module: Geospatial</title>
-    <!-- Invullen: de naam van de lokale CSS file =============================================== -->
-    <link rel="stylesheet" type="text/css" href="./media/style.css">
-    <link rel='shortcut icon' type='image/x-icon' href='https://tools.geostandaarden.nl/respec/style/logos/Geonovum.ico' />
-    <script src="config.js" class="remove"></script>
-    <script src="https://tools.geostandaarden.nl/respec/builds/respec-geonovum.js" class="remove" async></script>
-<!-- ============================================================================================ -->
-<!-- File. . . :  index.html                                                                      -->
-<!-- Bevat . . :  Template voor de index.html die verplicht is voor respec                        -->
-<!--              Gebaseerd op https://github.com/Geonovum/respec/wiki                            -->
-<!--              Deze file moet worden neergezet in de root-directory van de                     -->
-<!--              betreffende standaard.                                                          -->
-<!-- Door. . . :  Linda van den Brink                                                             -->
-<!-- ============================================================================================ -->
-<!-- ============================================================================================ -->
-<!-- Log . . . :  2019503 - LvdB - Initiele versie                                                -->
-<!--                                                                                              -->
-<!--
-====================================================================================================
-0        1         2         3         4         5         6         7         8         9         0
-1234567890123456789012345678901234567890123456789012345678901234567890123456789012345678901234567890
-================================================================================================= -->
-  </head>
-  <!-- HTML-Body ================================================================================ -->
-  <body>
-    <section id="abstract" data-format="markdown" data-include="abstract.md"></section>
-    <section id="sotd">ERRATUM: This version contains exactly the same text as the <a href="https://docs.geostandaarden.nl/api/def-hr-API-Strategie-mod-geo-20230522/">previous version</a>, but contains corrected Rule IDs.</section>
-    <!-- vanaf hier per hoofdstuk een sectie of een div in het document ======================== -->
-    <!-- Secties komen in de inhoudsopgave div's niet ========================================== -->
-    <!-- Secties hebben verplicht <h2> tags, div's niet ======================================== -->
-    <section data-format="markdown" data-include="introduction.md"></section>
-    <section data-format="markdown" data-include="request-response.md"></section>
-    <section data-format="markdown" data-include="crs.md"></section>
-    <section data-format="markdown" data-include="inspire.md"></section>
-    <section class="appendix" data-format="markdown" data-include="appendix.md"></section>
-  </body>
-</html>
+    <title>API Design Rules Module: Geospatial</title>
+    <script class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/organisation-config.js">
+    </script>
+    <script class="remove" src="js/config.js">
+    </script>
+    <script>
+        respecConfig = {...organisationConfig, ...respecConfig};
+    </script>
+    <link href="https://gitdocumentatie.logius.nl/publicatie/respec/style/logos/logius.ico" rel="shortcut icon" type="image/x-icon" />
+    <script async="" class="remove" src="https://gitdocumentatie.logius.nl/publicatie/respec/builds/respec-nlgov.js">
+    </script>
+</head>
+
+<body>
+    <section id="abstract" data-include-format="markdown" data-include="abstract.md"></section>
+    <section id="sotd"></section>
+        <section data-include-format="markdown" data-include="introduction.md"></section>
+        <section data-include-format="markdown" data-include="request-response.md"></section>
+        <section data-include-format="markdown" data-include="crs.md"></section>
+        <section data-include-format="markdown" data-include="inspire.md"></section>
+        <section class="appendix" data-include-format="markdown" data-include="appendix.md"></section>
+</body>
+
+</html>

js/config.js

@@ -0,0 +1,85 @@
+var respecConfig = {
+    pubDomain: "api",
+    shortName: "mod-geo",
+    specType: "HR",
+    specStatus: "DEF",
+    publishDate: "2024-03-07",
+    publishVersion: "1.0.2",
+    previousPublishDate: "2023-05-23",
+    previousPublishVersion: "1.0.1",
+    previousMaturity: "DEF",
+    editors: [{
+        name: "Linda van den Brink",
+        company: "Geonovum",
+        companyURL: "https://www.geonovum.nl",
+    }, ],
+    authors: [{
+        name: "Pieter Bresters",
+        company: "Geonovum",
+        companyURL: "https://www.geonovum.nl",
+    }, {
+        name: "Linda van den Brink",
+        company: "Geonovum",
+        companyURL: "https://www.geonovum.nl",
+    }, {
+        name: "Paul van Genuchten",
+        company: "ISRIC",
+        companyURL: "https://www.isric.org",
+    }, {
+        name: "George Mathijssen",
+        company: "Sweco Nederland B.V.",
+        companyURL: "https://www.sweco.nl",
+    }, {
+        name: "Mark Strijker",
+        company: "Het Kadaster",
+        companyURL: "https://www.kadaster.nl",
+    }, ],
+    github: "https://github.com/Logius-standaarden/API-mod-geospatial/",
+    localBiblio: {
+        "hr-crs": {
+            href: "https://docs.geostandaarden.nl/crs/crs/",
+            title: "Handreiking Gebruik coördinaatreferentiesystemen bij uitwisseling en visualisatie van geo-informatie",
+            authors: ["Lennard Huisman", "Friso Penninga"],
+            status: "Vastgesteld",
+            publisher: "Geonovum",
+        },
+        "ogcapi-features-1": {
+            href: "http://docs.ogc.org/is/17-069r3/17-069r3.html",
+            title: "OGC API - Features - Part 1: Core",
+            editors: ["Clemens Portele", "Panagiotis (Peter) A. Vretanos", "Charles Heazel"],
+            status: "Approved",
+            publisher: "Open Geospatial Consortium",
+            version: "1.0"
+        },
+        "ogcapi-features-2": {
+            href: "https://docs.ogc.org/is/18-058/18-058.html",
+            title: "OGC API - Features - Part 2: Coordinate Reference Systems by Reference",
+            editors: ["Clemens Portele", "Panagiotis (Peter) A. Vretanos"],
+            status: "Approved",
+            publisher: "Open Geospatial Consortium",
+            version: "1.0"
+        },
+        "ogcapi-features-3": {
+            href: "http://docs.ogc.org/DRAFTS/19-079r1.html",
+            title: "OGC API - Features - Part 3: Filtering",
+            editors: ["Panagiotis (Peter) A. Vretanos", "Clemens Portele"],
+            status: "Draft",
+            publisher: "Open Geospatial Consortium",
+            version: "1.0.0-rc.1"
+        },
+        "JSON-FG": {
+            href: "https://docs.ogc.org/DRAFTS/21-045.html",
+            title: "OGC Features and Geometries JSON - Part 1: Core",
+            editors: ["Clemens Portele", "Panagiotis (Peter) A. Vretanos"],
+            status: "Editor's Draft",
+            publisher: "Open Geospatial Consortium",
+            version: "0.1"
+        },
+        "HAL": {
+            href: "http://stateless.co/hal_specification.html",
+            title: "HAL - Hypertext Application Language",
+            authors: ["Mike Kelly"],
+            date: " 2013-09-18",
+        },
+    },
+};