From dba425b8013a0c9d678e732073b6e9f15f92685a Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Wed, 28 May 2025 10:20:57 +0200 Subject: [PATCH 1/9] Beheer: verplaats markdown naar `sections/` folder (#11) Hiermee draaien we markdownlint en zijn we consequent met ADR core. --- .gitattributes | 1 + .github/workflows/build.yml | 2 +- index.html | 12 +-- abstract.md => sections/abstract.md | 2 +- appendix.md => sections/appendix.md | 9 +- crs.md => sections/crs.md | 44 +++++----- inspire.md => sections/inspire.md | 3 +- introduction.md => sections/introduction.md | 4 +- .../request-response.md | 84 ++++++++++--------- 9 files changed, 85 insertions(+), 76 deletions(-) create mode 100644 .gitattributes rename abstract.md => sections/abstract.md (97%) rename appendix.md => sections/appendix.md (97%) rename crs.md => sections/crs.md (95%) rename inspire.md => sections/inspire.md (98%) rename introduction.md => sections/introduction.md (94%) rename request-response.md => sections/request-response.md (93%) diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..3e48839 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text eol=lf diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 1b5d3c4..090c9c4 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -13,7 +13,7 @@ jobs: check: needs: build name: Check - uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main + uses: Logius-standaarden/Automatisering/.github/workflows/check.yml@main publish: needs: build name: Publish (Logius) diff --git a/index.html b/index.html index 43a7fe1..5da8d70 100644 --- a/index.html +++ b/index.html @@ -19,19 +19,19 @@ -
+
-
+
-
+
-
+
-
+
-
+
diff --git a/abstract.md b/sections/abstract.md similarity index 97% rename from abstract.md rename to sections/abstract.md index 8bbb2f9..13b0a54 100644 --- a/abstract.md +++ b/sections/abstract.md @@ -16,4 +16,4 @@ The Nederlandse API Strategie consists of [a set of distinct documents](https:// Before reading this document it is advised to gain knowledge of the informative documents, in particular the [Architecture](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/). -This document describes the *Geospatial module*, containing rules for geospatial content and functions in APIs. \ No newline at end of file +This document describes the *Geospatial module*, containing rules for geospatial content and functions in APIs. diff --git a/appendix.md b/sections/appendix.md similarity index 97% rename from appendix.md rename to sections/appendix.md index 4a4c93f..e1518b2 100644 --- a/appendix.md +++ b/sections/appendix.md @@ -1,11 +1,12 @@ # 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. + +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 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): @@ -48,11 +49,11 @@ The `POST` endpoint is preferably set up as a generic query endpoint to support ## Old CRS negotiation method - -
-

/geo/default-crs: Use CRS84 as the default coordinate reference system (CRS) in line with OGC API Features Requirement 10

+
+

Use CRS84 as the default coordinate reference system (CRS) in line with OGC API Features Requirement 10

Statement
@@ -110,8 +110,8 @@ When referring to a coordinate reference system using its code in the rest of th
-
-

/geo/preferred-crs: Use ETRS89 and/or RD when required

+
+

Use ETRS89 and/or RD when required

Statement
@@ -144,8 +144,8 @@ The guiding principles for CRS support: - APIs shall support and advertise both ensemble CRSs and ensemble member CRSs if geometry is exchanged and the CRS for the geometry is an ensemble member CRS. - Under certain conditions WGS 84 can be made equal to e.g. ETRS89, this is called a 'null transformation', see [[hr-crs]]. If a null transformation is used to realize WGS 84, then the CRS (e.g. ETRS89) that is used to realize WGS 84 and the CRS for WGS 84 itself shall both be supported and advertised by an API. -
-

/geo/ensemble-member-crs: The ensemble member should be one of the CRSs supported by the API

+
+

The ensemble member should be one of the CRSs supported by the API

Statement
@@ -163,8 +163,8 @@ The guiding principles for CRS support:
-
-

/geo/bbox-crs-query-parameter: Support passing the coordinate reference system (CRS) of the bounding box in the request as a query parameter

+
+

Support passing the coordinate reference system (CRS) of the bounding box in the request as a query parameter

Statement
@@ -183,8 +183,8 @@ The guiding principles for CRS support:
-
-

/geo/filter-crs-query-parameter: Support passing the coordinate reference system (CRS) of the geospatial filter in the request as a query parameter

+
+

Support passing the coordinate reference system (CRS) of the geospatial filter in the request as a query parameter

Statement
@@ -205,8 +205,8 @@ The guiding principles for CRS support: In an API that supports the creation and/or updating of items, POST, PUT or PATCH requests with geospatial content in the body may be sent by a client to the server. In that case, it is necessary to indicate the CRS used, unless CRS84 (OGC:CRS84), the default CRS, is used. -
-

/geo/content-crs-request-header: When HTTP POST, PUT and/or PATCH requests are supported, pass the coordinate reference system (CRS) of geometry in the request body as a header

+
+

When HTTP POST, PUT and/or PATCH requests are supported, pass the coordinate reference system (CRS) of geometry in the request body as a header

Statement
@@ -225,8 +225,8 @@ In an API that supports the creation and/or updating of items, POST, PUT or PATC
-
-

/geo/crs-query-parameter: Support passing the desired coordinate reference system (CRS) of the geometry in the response as a query parameter

+
+

Support passing the desired coordinate reference system (CRS) of the geometry in the response as a query parameter

Statement
@@ -242,8 +242,8 @@ In an API that supports the creation and/or updating of items, POST, PUT or PATC
-
-

/geo/content-crs-response-header: Assert the coordinate reference system (CRS) used in the response using a header

+
+

Assert the coordinate reference system (CRS) used in the response using a header

Statement
diff --git a/sections/introduction.md b/sections/introduction.md index 66745d9..675ea45 100644 --- a/sections/introduction.md +++ b/sections/introduction.md @@ -14,3 +14,11 @@ Geospatial data is 'special' data in the sense that it typically indicates the l The Geospatial Module provides rules for the structuring of geospatial payloads and for functions in APIs to handle geospatial data. + +## Functional rules + +
    + +## Technical rules + +
      diff --git a/sections/request-response.md b/sections/request-response.md index 0681106..2182bc2 100644 --- a/sections/request-response.md +++ b/sections/request-response.md @@ -70,8 +70,8 @@ GeoJSON does not cover all use cases. For example, it is not possible to store c A simple spatial filter can be supplied as a bounding box. This is a common way of filtering spatial data and can be supplied as a parameter. We adopt the OGC API Features [[ogcapi-features-1]] bounding box parameter: -
      -

      /geo/bbox-query-parameter: Supply a simple spatial filter as a bounding box parameter

      +
      +

      Supply a simple spatial filter as a bounding box parameter

      Statement
      @@ -112,8 +112,8 @@ However, until the filtering module is written, the geospatial module retains ru -
      -

      /geo/geometric-context: Place results of a global spatial query in the relevant geometric context

      +
      +

      Place results of a global spatial query in the relevant geometric context

      Statement
      @@ -162,8 +162,8 @@ However, until the filtering module is written, the geospatial module retains ru In case a REST API shall comply to the OGC API Features specification for creating, updating and deleting a resource, the following applies. -
      -

      /geo/geojson-request: Support GeoJSON in geospatial API requests

      +
      +

      Support GeoJSON in geospatial API requests

      Statement
      @@ -224,8 +224,8 @@ In case a REST API does not have to comply to the OGC API Features specification A template for the definition of the schemas for the GeoJSON Geometry object in the requests in OpenAPI definitions is available: [geometryGeoJSON.yaml](https://schemas.opengis.net/ogcapi/features/part1/1.0/openapi/schemas/geometryGeoJSON.yaml). In case a collection of resources is embedded in the request resource, the name of the array containing the resources should be the plural of the resource name. -
      -

      /geo/embed-geojson-geometry-request: Embed GeoJSON Geometry object as part of the JSON resource in API requests

      +
      +

      Embed GeoJSON Geometry object as part of the JSON resource in API requests

      Statement
      @@ -279,8 +279,8 @@ In case a collection of resources is embedded in the request resource, the name In case a REST API shall comply to the OGC API Features specification, e.g. for usage in GIS applications, the following applies. -
      -

      /geo/geojson-response: Support GeoJSON in geospatial API responsess

      +
      +

      Support GeoJSON in geospatial API responsess

      Statement
      @@ -395,8 +395,8 @@ A template for the definition of the schemas for the GeoJSON Geometry -
      -

      /geo/embed-geojson-geometry-response: Embed GeoJSON Geometry object as part of the JSON resource in API responses

      +
      +

      Embed GeoJSON Geometry object as part of the JSON resource in API responses

      Statement
      From 469d61add7cec70996623d331d4406bc41a764f5 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Mon, 9 Mar 2026 11:29:12 +0100 Subject: [PATCH 5/9] Beheer: voeg summary toe voor regels (#18) Dit is vereist met de laatste versie van de plugins voor ADR rules. --- sections/introduction.md | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/sections/introduction.md b/sections/introduction.md index 675ea45..142d4c5 100644 --- a/sections/introduction.md +++ b/sections/introduction.md @@ -15,10 +15,6 @@ Geospatial data is 'special' data in the sense that it typically indicates the l The Geospatial Module provides rules for the structuring of geospatial payloads and for functions in APIs to handle geospatial data. -## Functional rules +## Summary -
        - -## Technical rules - -
          +
          From a22bafe5ba57624ec75d3a188371c91e8ed9b3f5 Mon Sep 17 00:00:00 2001 From: Alexander Green Date: Mon, 9 Mar 2026 11:29:34 +0100 Subject: [PATCH 6/9] Beheer: voeg LICENSE toe (#17) --- LICENSE | 395 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 395 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..4ea99c2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,395 @@ +Attribution 4.0 International + +======================================================================= + +Creative Commons Corporation ("Creative Commons") is not a law firm and +does not provide legal services or legal advice. Distribution of +Creative Commons public licenses does not create a lawyer-client or +other relationship. Creative Commons makes its licenses and related +information available on an "as-is" basis. Creative Commons gives no +warranties regarding its licenses, any material licensed under their +terms and conditions, or any related information. Creative Commons +disclaims all liability for damages resulting from their use to the +fullest extent possible. + +Using Creative Commons Public Licenses + +Creative Commons public licenses provide a standard set of terms and +conditions that creators and other rights holders may use to share +original works of authorship and other material subject to copyright +and certain other rights specified in the public license below. The +following considerations are for informational purposes only, are not +exhaustive, and do not form part of our licenses. + + Considerations for licensors: Our public licenses are + intended for use by those authorized to give the public + permission to use material in ways otherwise restricted by + copyright and certain other rights. Our licenses are + irrevocable. Licensors should read and understand the terms + and conditions of the license they choose before applying it. + Licensors should also secure all rights necessary before + applying our licenses so that the public can reuse the + material as expected. Licensors should clearly mark any + material not subject to the license. This includes other CC- + licensed material, or material used under an exception or + limitation to copyright. More considerations for licensors: + wiki.creativecommons.org/Considerations_for_licensors + + Considerations for the public: By using one of our public + licenses, a licensor grants the public permission to use the + licensed material under specified terms and conditions. If + the licensor's permission is not necessary for any reason--for + example, because of any applicable exception or limitation to + copyright--then that use is not regulated by the license. Our + licenses grant only permissions under copyright and certain + other rights that a licensor has authority to grant. Use of + the licensed material may still be restricted for other + reasons, including because others have copyright or other + rights in the material. A licensor may make special requests, + such as asking that all changes be marked or described. + Although not required by our licenses, you are encouraged to + respect those requests where reasonable. More considerations + for the public: + wiki.creativecommons.org/Considerations_for_licensees + +======================================================================= + +Creative Commons Attribution 4.0 International Public License + +By exercising the Licensed Rights (defined below), You accept and agree +to be bound by the terms and conditions of this Creative Commons +Attribution 4.0 International Public License ("Public License"). To the +extent this Public License may be interpreted as a contract, You are +granted the Licensed Rights in consideration of Your acceptance of +these terms and conditions, and the Licensor grants You such rights in +consideration of benefits the Licensor receives from making the +Licensed Material available under these terms and conditions. + + +Section 1 -- Definitions. + + a. Adapted Material means material subject to Copyright and Similar + Rights that is derived from or based upon the Licensed Material + and in which the Licensed Material is translated, altered, + arranged, transformed, or otherwise modified in a manner requiring + permission under the Copyright and Similar Rights held by the + Licensor. For purposes of this Public License, where the Licensed + Material is a musical work, performance, or sound recording, + Adapted Material is always produced where the Licensed Material is + synched in timed relation with a moving image. + + b. Adapter's License means the license You apply to Your Copyright + and Similar Rights in Your contributions to Adapted Material in + accordance with the terms and conditions of this Public License. + + c. Copyright and Similar Rights means copyright and/or similar rights + closely related to copyright including, without limitation, + performance, broadcast, sound recording, and Sui Generis Database + Rights, without regard to how the rights are labeled or + categorized. For purposes of this Public License, the rights + specified in Section 2(b)(1)-(2) are not Copyright and Similar + Rights. + + d. Effective Technological Measures means those measures that, in the + absence of proper authority, may not be circumvented under laws + fulfilling obligations under Article 11 of the WIPO Copyright + Treaty adopted on December 20, 1996, and/or similar international + agreements. + + e. Exceptions and Limitations means fair use, fair dealing, and/or + any other exception or limitation to Copyright and Similar Rights + that applies to Your use of the Licensed Material. + + f. Licensed Material means the artistic or literary work, database, + or other material to which the Licensor applied this Public + License. + + g. Licensed Rights means the rights granted to You subject to the + terms and conditions of this Public License, which are limited to + all Copyright and Similar Rights that apply to Your use of the + Licensed Material and that the Licensor has authority to license. + + h. Licensor means the individual(s) or entity(ies) granting rights + under this Public License. + + i. Share means to provide material to the public by any means or + process that requires permission under the Licensed Rights, such + as reproduction, public display, public performance, distribution, + dissemination, communication, or importation, and to make material + available to the public including in ways that members of the + public may access the material from a place and at a time + individually chosen by them. + + j. Sui Generis Database Rights means rights other than copyright + resulting from Directive 96/9/EC of the European Parliament and of + the Council of 11 March 1996 on the legal protection of databases, + as amended and/or succeeded, as well as other essentially + equivalent rights anywhere in the world. + + k. You means the individual or entity exercising the Licensed Rights + under this Public License. Your has a corresponding meaning. + + +Section 2 -- Scope. + + a. License grant. + + 1. Subject to the terms and conditions of this Public License, + the Licensor hereby grants You a worldwide, royalty-free, + non-sublicensable, non-exclusive, irrevocable license to + exercise the Licensed Rights in the Licensed Material to: + + a. reproduce and Share the Licensed Material, in whole or + in part; and + + b. produce, reproduce, and Share Adapted Material. + + 2. Exceptions and Limitations. For the avoidance of doubt, where + Exceptions and Limitations apply to Your use, this Public + License does not apply, and You do not need to comply with + its terms and conditions. + + 3. Term. The term of this Public License is specified in Section + 6(a). + + 4. Media and formats; technical modifications allowed. The + Licensor authorizes You to exercise the Licensed Rights in + all media and formats whether now known or hereafter created, + and to make technical modifications necessary to do so. The + Licensor waives and/or agrees not to assert any right or + authority to forbid You from making technical modifications + necessary to exercise the Licensed Rights, including + technical modifications necessary to circumvent Effective + Technological Measures. For purposes of this Public License, + simply making modifications authorized by this Section 2(a) + (4) never produces Adapted Material. + + 5. Downstream recipients. + + a. Offer from the Licensor -- Licensed Material. Every + recipient of the Licensed Material automatically + receives an offer from the Licensor to exercise the + Licensed Rights under the terms and conditions of this + Public License. + + b. No downstream restrictions. You may not offer or impose + any additional or different terms or conditions on, or + apply any Effective Technological Measures to, the + Licensed Material if doing so restricts exercise of the + Licensed Rights by any recipient of the Licensed + Material. + + 6. No endorsement. Nothing in this Public License constitutes or + may be construed as permission to assert or imply that You + are, or that Your use of the Licensed Material is, connected + with, or sponsored, endorsed, or granted official status by, + the Licensor or others designated to receive attribution as + provided in Section 3(a)(1)(A)(i). + + b. Other rights. + + 1. Moral rights, such as the right of integrity, are not + licensed under this Public License, nor are publicity, + privacy, and/or other similar personality rights; however, to + the extent possible, the Licensor waives and/or agrees not to + assert any such rights held by the Licensor to the limited + extent necessary to allow You to exercise the Licensed + Rights, but not otherwise. + + 2. Patent and trademark rights are not licensed under this + Public License. + + 3. To the extent possible, the Licensor waives any right to + collect royalties from You for the exercise of the Licensed + Rights, whether directly or through a collecting society + under any voluntary or waivable statutory or compulsory + licensing scheme. In all other cases the Licensor expressly + reserves any right to collect such royalties. + + +Section 3 -- License Conditions. + +Your exercise of the Licensed Rights is expressly made subject to the +following conditions. + + a. Attribution. + + 1. If You Share the Licensed Material (including in modified + form), You must: + + a. retain the following if it is supplied by the Licensor + with the Licensed Material: + + i. identification of the creator(s) of the Licensed + Material and any others designated to receive + attribution, in any reasonable manner requested by + the Licensor (including by pseudonym if + designated); + + ii. a copyright notice; + + iii. a notice that refers to this Public License; + + iv. a notice that refers to the disclaimer of + warranties; + + v. a URI or hyperlink to the Licensed Material to the + extent reasonably practicable; + + b. indicate if You modified the Licensed Material and + retain an indication of any previous modifications; and + + c. indicate the Licensed Material is licensed under this + Public License, and include the text of, or the URI or + hyperlink to, this Public License. + + 2. You may satisfy the conditions in Section 3(a)(1) in any + reasonable manner based on the medium, means, and context in + which You Share the Licensed Material. For example, it may be + reasonable to satisfy the conditions by providing a URI or + hyperlink to a resource that includes the required + information. + + 3. If requested by the Licensor, You must remove any of the + information required by Section 3(a)(1)(A) to the extent + reasonably practicable. + + 4. If You Share Adapted Material You produce, the Adapter's + License You apply must not prevent recipients of the Adapted + Material from complying with this Public License. + + +Section 4 -- Sui Generis Database Rights. + +Where the Licensed Rights include Sui Generis Database Rights that +apply to Your use of the Licensed Material: + + a. for the avoidance of doubt, Section 2(a)(1) grants You the right + to extract, reuse, reproduce, and Share all or a substantial + portion of the contents of the database; + + b. if You include all or a substantial portion of the database + contents in a database in which You have Sui Generis Database + Rights, then the database in which You have Sui Generis Database + Rights (but not its individual contents) is Adapted Material; and + + c. You must comply with the conditions in Section 3(a) if You Share + all or a substantial portion of the contents of the database. + +For the avoidance of doubt, this Section 4 supplements and does not +replace Your obligations under this Public License where the Licensed +Rights include other Copyright and Similar Rights. + + +Section 5 -- Disclaimer of Warranties and Limitation of Liability. + + a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE + EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS + AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF + ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS, + IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION, + WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR + PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS, + ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT + KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT + ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU. + + b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE + TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION, + NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT, + INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES, + COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR + USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN + ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR + DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR + IN PART, THIS LIMITATION MAY NOT APPLY TO YOU. + + c. The disclaimer of warranties and limitation of liability provided + above shall be interpreted in a manner that, to the extent + possible, most closely approximates an absolute disclaimer and + waiver of all liability. + + +Section 6 -- Term and Termination. + + a. This Public License applies for the term of the Copyright and + Similar Rights licensed here. However, if You fail to comply with + this Public License, then Your rights under this Public License + terminate automatically. + + b. Where Your right to use the Licensed Material has terminated under + Section 6(a), it reinstates: + + 1. automatically as of the date the violation is cured, provided + it is cured within 30 days of Your discovery of the + violation; or + + 2. upon express reinstatement by the Licensor. + + For the avoidance of doubt, this Section 6(b) does not affect any + right the Licensor may have to seek remedies for Your violations + of this Public License. + + c. For the avoidance of doubt, the Licensor may also offer the + Licensed Material under separate terms or conditions or stop + distributing the Licensed Material at any time; however, doing so + will not terminate this Public License. + + d. Sections 1, 5, 6, 7, and 8 survive termination of this Public + License. + + +Section 7 -- Other Terms and Conditions. + + a. The Licensor shall not be bound by any additional or different + terms or conditions communicated by You unless expressly agreed. + + b. Any arrangements, understandings, or agreements regarding the + Licensed Material not stated herein are separate from and + independent of the terms and conditions of this Public License. + + +Section 8 -- Interpretation. + + a. For the avoidance of doubt, this Public License does not, and + shall not be interpreted to, reduce, limit, restrict, or impose + conditions on any use of the Licensed Material that could lawfully + be made without permission under this Public License. + + b. To the extent possible, if any provision of this Public License is + deemed unenforceable, it shall be automatically reformed to the + minimum extent necessary to make it enforceable. If the provision + cannot be reformed, it shall be severed from this Public License + without affecting the enforceability of the remaining terms and + conditions. + + c. No term or condition of this Public License will be waived and no + failure to comply consented to unless expressly agreed to by the + Licensor. + + d. Nothing in this Public License constitutes or may be interpreted + as a limitation upon, or waiver of, any privileges and immunities + that apply to the Licensor or You, including from the legal + processes of any jurisdiction or authority. + + +======================================================================= + +Creative Commons is not a party to its public +licenses. Notwithstanding, Creative Commons may elect to apply one of +its public licenses to material it publishes and in those instances +will be considered the “Licensor.” The text of the Creative Commons +public licenses is dedicated to the public domain under the CC0 Public +Domain Dedication. Except for the limited purpose of indicating that +material is shared under a Creative Commons public license or as +otherwise permitted by the Creative Commons policies published at +creativecommons.org/policies, Creative Commons does not authorize the +use of the trademark "Creative Commons" or any other trademark or logo +of Creative Commons without its prior written consent including, +without limitation, in connection with any unauthorized modifications +to any of its public licenses or any other arrangements, +understandings, or agreements concerning use of licensed material. For +the avoidance of doubt, this paragraph does not form part of the +public licenses. + +Creative Commons may be contacted at creativecommons.org. From 15123a18c726d33a6c6f4d8099eda7650df3ee12 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Mon, 9 Mar 2026 11:34:57 +0100 Subject: [PATCH 7/9] Beheer: fix markdown linter errors (#19) --- sections/abstract.md | 18 +++++++++--------- sections/crs.md | 42 +++++++++++++++++++++--------------------- 2 files changed, 30 insertions(+), 30 deletions(-) diff --git a/sections/abstract.md b/sections/abstract.md index 13b0a54..7e8ab30 100644 --- a/sections/abstract.md +++ b/sections/abstract.md @@ -2,16 +2,16 @@ This document is part of the *Nederlandse API Strategie*. The Nederlandse API Strategie consists of [a set of distinct documents](https://www.geonovum.nl/themas/kennisplatform-apis#APIStrategie). -| Status | Description & Link | -| ---------------- | ------------------------------------------------------------ | -| Informative | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | -| Informative | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | +| Status | Description & Link | +|------------------|------------------------------------------------------------------------------------------------------------------| +| Informative | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | +| Informative | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | | Informative | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | -| Normative | [API Design Rules (ADR v2.0)](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0/) | -| Normative | [Open API Specification (OAS 3.0)](https://spec.openapis.org/oas/v3.0.1.html) | -| Normative | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | -| Normative | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | -| Normative module | [GEO module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-geo/1.0.2/) | +| Normative | [API Design Rules (ADR v2.0)](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0/) | +| Normative | [Open API Specification (OAS 3.0)](https://spec.openapis.org/oas/v3.0.1.html) | +| Normative | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | +| Normative | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | +| Normative module | [GEO module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-geo/1.0.2/) | Before reading this document it is advised to gain knowledge of the informative documents, in particular the [Architecture](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/). diff --git a/sections/crs.md b/sections/crs.md index 69e9272..d5835f3 100644 --- a/sections/crs.md +++ b/sections/crs.md @@ -261,30 +261,30 @@ In an API that supports the creation and/or updating of items, POST, PUT or PATC The API should be able to handle the following scenarios based on the rules stated above: -| Scenario | Explanation | -| ----------------------------------------------- | ----------- | -| No geometry in request, no geometry in response | No CRS negotiation necessary | -| No geometry in request, geometry in response | The client can request a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in the response using the `Content-Crs` header. | -| Geometry in request body, no geometry in response | The client indicates the CRS of the geometry in the request body using the `Content-Crs` header. | -| Geometry in request body, geometry in response | The client indicates the CRS of the geometry in the request body using the `Content-Crs` header, and can request a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in the response using the `Content-Crs` header. | -| Geometry filter in request, no geometry in response | The client indicates the CRS of the geometry filter in the request using the `bbox-crs` parameter if a bounding box is used to filter geospatially, or the `filter-crs` parameter if another way of geospatial filtering is used.| -| Geometry filter in request, geometry in response | The client indicates the CRS of the geometry filter in the request using `bbox-crs` or `filter-crs` as in the previous scenario, and requests a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in response using the `Content-Crs` header.| +| Scenario | Explanation | +|-----------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| No geometry in request, no geometry in response | No CRS negotiation necessary | +| No geometry in request, geometry in response | The client can request a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in the response using the `Content-Crs` header. | +| Geometry in request body, no geometry in response | The client indicates the CRS of the geometry in the request body using the `Content-Crs` header. | +| Geometry in request body, geometry in response | The client indicates the CRS of the geometry in the request body using the `Content-Crs` header, and can request a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in the response using the `Content-Crs` header. | +| Geometry filter in request, no geometry in response | The client indicates the CRS of the geometry filter in the request using the `bbox-crs` parameter if a bounding box is used to filter geospatially, or the `filter-crs` parameter if another way of geospatial filtering is used. | +| Geometry filter in request, geometry in response | The client indicates the CRS of the geometry filter in the request using `bbox-crs` or `filter-crs` as in the previous scenario, and requests a specific CRS for the geometries in the response using the `crs` parameter. The server indicates the geometry CRS in response using the `Content-Crs` header. | Below is a list of the most commonly used CRSs in the Netherlands: -| Name | Code | Type | Dimension | Scope | URI | -|-|-|-|-|-|-| -| Amersfoort / RD New | 28992 | easting, northing (x, y) | 2D | Dutch | | -| Amersfoort / RD New + NAP height | 7415 | easting, northing, height (x, y, h) | 3D | Dutch | | -| ETRS89 | 4258 | latitude, longitude (φ, λ) |2D | European | | -| ETRS89 | 4937 | latitude, longitude, height (φ, λ, h) | 3D | European | | -| ETRF2000 | 7931 | latitude, longitude, height (φ, λ, h) | 3D | European | | -| ETRF2000 | 9067 | latitude, longitude (φ, λ) | 2D | European | | -| ITRF2014 | 7912 | latitude, longitude, height (φ, λ, h) | 3D | Global | | -| ITRF2014 | 9000 | latitude, longitude (φ, λ) | 2D | Global | | -| WGS 84 longitude-latitude | CRS84 | longitude, latitude (λ, φ) | 2D | Global | | -| WGS 84 longitude-latitude-height | CRS84h | longitude, latitude, height (λ, φ, h) | 3D | Global | | -| WGS 84 / Pseudo-Mercator | 3857 | easting, northing (x, y) | 2D | Global | | +| Name | Code | Type | Dimension | Scope | URI | +|----------------------------------|--------|---------------------------------------|-----------|----------|-----| +| Amersfoort / RD New | 28992 | easting, northing (x, y) | 2D | Dutch | | +| Amersfoort / RD New + NAP height | 7415 | easting, northing, height (x, y, h) | 3D | Dutch | | +| ETRS89 | 4258 | latitude, longitude (φ, λ) | 2D | European | | +| ETRS89 | 4937 | latitude, longitude, height (φ, λ, h) | 3D | European | | +| ETRF2000 | 7931 | latitude, longitude, height (φ, λ, h) | 3D | European | | +| ETRF2000 | 9067 | latitude, longitude (φ, λ) | 2D | European | | +| ITRF2014 | 7912 | latitude, longitude, height (φ, λ, h) | 3D | Global | | +| ITRF2014 | 9000 | latitude, longitude (φ, λ) | 2D | Global | | +| WGS 84 longitude-latitude | CRS84 | longitude, latitude (λ, φ) | 2D | Global | | +| WGS 84 longitude-latitude-height | CRS84h | longitude, latitude, height (λ, φ, h) | 3D | Global | | +| WGS 84 / Pseudo-Mercator | 3857 | easting, northing (x, y) | 2D | Global | | For a more extensive overview of CRSs see: . Note that the URI of each CRS contains a version number and that new versions may be released in future. From 4a983b16e2e0e5627a9c1dab73f90e51c6bb03f3 Mon Sep 17 00:00:00 2001 From: Tim van der Lippe Date: Fri, 22 May 2026 09:02:57 +0200 Subject: [PATCH 8/9] Beheer: gebruik NLgov notatie voor namen van standaarden (#20) --- README.md | 36 +++++++++++++++++++++--------------- sections/abstract.md | 6 +++--- sections/request-response.md | 6 +++--- 3 files changed, 27 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fffa1f0..68d6879 100644 --- a/README.md +++ b/README.md @@ -1,17 +1,23 @@ # API Design Rules Module: Geospatial -## 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 +### Links + +- NLgov REST API Design Rules (ADR) + - [Formele standaard](https://forumstandaardisatie.nl/open-standaarden/rest-api-design-rules) + - [Gepubliceerde versie](https://gitdocumentatie.logius.nl/publicatie/api/adr/) + - [Werkversie](https://logius-standaarden.github.io/API-Design-Rules/) + - [Repository](https://github.com/Logius-standaarden/API-Design-Rules) + +- NLgov Assurance profile for OAuth 2.0 (OAuth) + - [Formele standaard](https://forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oauth-20) + - [Gepubliceerde versie](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) + - [Werkversie](https://logius-standaarden.github.io/OAuth-NL-profiel/) + - [Repository](https://github.com/Logius-standaarden/OAuth-NL-profiel) + +- NLgov Assurance profile for OpenID Connect 1.0 (OIDC) + - [Formele standaard](https://forumstandaardisatie.nl/open-standaarden/nl-gov-assurance-profile-oidc) + - [Gepubliceerde versie](https://gitdocumentatie.logius.nl/publicatie/api/oidc/) + - [Werkversie](https://logius-standaarden.github.io/OIDC-NLGOV/) + - [Repository](https://github.com/Logius-standaarden/OIDC-NLGOV) + +Het **Beheermodel** voor deze standaarden is gepubliceerd op: https://gitdocumentatie.logius.nl/publicatie/api/beheermodel/ diff --git a/sections/abstract.md b/sections/abstract.md index 7e8ab30..03c650a 100644 --- a/sections/abstract.md +++ b/sections/abstract.md @@ -1,15 +1,15 @@ This document is part of the *Nederlandse API Strategie*. -The Nederlandse API Strategie consists of [a set of distinct documents](https://www.geonovum.nl/themas/kennisplatform-apis#APIStrategie). +The Nederlandse API Strategie consists of [a set of distinct documents](https://developer.overheid.nl/communities/kennisplatform-apis/#api-strategie). | Status | Description & Link | |------------------|------------------------------------------------------------------------------------------------------------------| | Informative | [Inleiding NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Inleiding/) | | Informative | [Architectuur NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Architectuur/) | | Informative | [Gebruikerswensen NL API Strategie](https://geonovum.github.io/KP-APIs/API-strategie-algemeen/Gebruikerswensen/) | -| Normative | [API Design Rules (ADR v2.0)](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.0/) | +| Normative | [NLgov REST API Design Rules (ADR v2.2)](https://gitdocumentatie.logius.nl/publicatie/api/adr/2.2/) | | Normative | [Open API Specification (OAS 3.0)](https://spec.openapis.org/oas/v3.0.1.html) | -| Normative | [NL GOV OAuth profiel](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | +| Normative | [NLgov Assurance profile for OAuth 2.0](https://gitdocumentatie.logius.nl/publicatie/api/oauth/) | | Normative | [Digikoppeling REST API koppelvlak specificatie](https://gitdocumentatie.logius.nl/publicatie/dk/restapi/) | | Normative module | [GEO module v1.0](https://gitdocumentatie.logius.nl/publicatie/api/mod-geo/1.0.2/) | diff --git a/sections/request-response.md b/sections/request-response.md index 2182bc2..1ef65c7 100644 --- a/sections/request-response.md +++ b/sections/request-response.md @@ -14,7 +14,7 @@ The Geospatial Module is focused on JSON-based encoding of data. However, consid ## GeoJSON -[[rfc7946]] describes the GeoJSON format, including a convention for describing 2D geometric objects in CRS84 (OGC:CRS84). In the Geospatial module of the API strategy we adopt the GeoJSON conventions for describing geometry objects. The convention is extended to allow alternative projections. +[[RFC7946]] describes the GeoJSON format, including a convention for describing 2D geometric objects in CRS84 (OGC:CRS84). In the Geospatial module of the API strategy we adopt the GeoJSON conventions for describing geometry objects. The convention is extended to allow alternative projections. The GeoJSON conventions and extensions described in this module apply to both geometry passed in input parameters and responses.