Skip to content

Statement, Rationale, Implications #121

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mrtn78 merged 7 commits into from
Feb 13, 2023
Merged

Statement, Rationale, Implications #121

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
bb270c6
Rule 05, 54, 04, 48
sanderke Apr 22, 2022
ffe3e6d
Update The Design Rules v1.0.md
sanderke Apr 22, 2022
8367872
Update The Design Rules v1.0.md
sanderke Apr 26, 2022
ddd49c6
Alle Rules bijgewerkt in nieuwe format
mrtn78 Jan 25, 2023
5cb9128
typo
mrtn78 Jan 25, 2023
3570ebd
Merge pull request #122 from Logius-standaarden/develop
mrtn78 Jan 25, 2023
bb3a446
Removed version numbers from file names
sanderke Jan 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
0 Abstract v1.0.md → Abstract.md
View file
Open in desktop
File renamed without changes.
667 changes: 667 additions & 0 deletions DesignRules.md
View file
Open in desktop

Large diffs are not rendered by default.

0 Glossary v1.0.md → Glossary.md
View file
Open in desktop
File renamed without changes.
0 Introduction v1.0.md → Introduction.md
View file
Open in desktop
File renamed without changes.
40 changes: 21 additions & 19 deletions Summary v1.0.md → Summary.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,22 +6,24 @@ Design rules have unique and permanent numbers. In the event of design rules bei

### Normative Design Rules

* <a href="#api-01">API-01</a>: Adhere to HTTP safety and idempotency semantics for operations
* <a href="#api-02">API-02</a>: Do not maintain session state on the server
* <a href="#api-03">API-03</a>: Only apply standard HTTP methods
* <a href="#api-04">API-04</a>: Define interfaces in Dutch unless there is an official English glossary available
* <a href="#api-05">API-05</a>: Use nouns to name resources
* <a href="#api-06">API-06</a>: Use nested URIs for child resources
* <a href="#api-10">API-10</a>: Model resource operations as a sub-resource or dedicated resource
* <a href="#api-16">API-16</a>: Use OpenAPI Specification for documentation
* <a href="#api-17">API-17</a>: Publish documentation in Dutch unless there is existing documentation in English
* <a href="#api-18">API-18</a>: Include a deprecation schedule when publishing API changes
* <a href="#api-19">API-19</a>: Schedule a fixed transition period for a new major API version
* <a href="#api-20">API-20</a>: Include the major version number in the URI
* <a href="#api-48">API-48</a>: Leave off trailing slashes from URIs
* <a href="#api-51">API-51</a>: Publish OAS document at a standard location in JSON-format
* <a href="#api-53">API-53</a>: Hide irrelevant implementation details
* <a href="#api-54">API-54</a>: Use plural nouns to name collection resources
* <a href="#api-55">API-55</a>: Publish a changelog for API changes between versions
* <a href="#api-56">API-56</a>: Adhere to the Semantic Versioning model when releasing API changes
* <a href="#api-57">API-57</a>: Return the full version number in a response header
Design rules can be technical rules, which should be tested automatically and functional rules which should be considerd when designing and building the api.

* <a href="#api-01">API-01</a>: Adhere to HTTP safety and idempotency semantics for operations - *Functional rule*
* <a href="#api-02">API-02</a>: Do not maintain session state on the server - *Functional rule*
* <a href="#api-03">API-03</a>: Only apply standard HTTP methods - *Technical rule*
* <a href="#api-04">API-04</a>: Define interfaces in Dutch unless there is an official English glossary available - *Functional rule*
* <a href="#api-05">API-05</a>: Use nouns to name resources - *Functional rule*
* <a href="#api-06">API-06</a>: Use nested URIs for child resources - *Functional rule*
* <a href="#api-10">API-10</a>: Model resource operations as a sub-resource or dedicated resource - *Functional rule*
* <a href="#api-16">API-16</a>: Use OpenAPI Specification for documentation - *Technical rule*
* <a href="#api-17">API-17</a>: Publish documentation in Dutch unless there is existing documentation in English - *Functional rule*
* <a href="#api-18">API-18</a>: Include a deprecation schedule when publishing API changes - *Functional rule*
* <a href="#api-19">API-19</a>: Schedule a fixed transition period for a new major API version - *Functional rule*
* <a href="#api-20">API-20</a>: Include the major version number in the URI - *Technical rule*
* <a href="#api-48">API-48</a>: Leave off trailing slashes from URIs - *Technical rule*
* <a href="#api-51">API-51</a>: Publish OAS document at a standard location in JSON-format - *Technical rule*
* <a href="#api-53">API-53</a>: Hide irrelevant implementation details - *Functional rule*
* <a href="#api-54">API-54</a>: Use plural nouns to name collection resources - *Functional rule*
* <a href="#api-55">API-55</a>: Publish a changelog for API changes between versions - *Functional rule*
* <a href="#api-56">API-56</a>: Adhere to the Semantic Versioning model when releasing API changes - *Technical rule*
* <a href="#api-57">API-57</a>: Return the full version number in a response header - *Technical rule*
335 changes: 0 additions & 335 deletions The Design Rules v1.0.md
View file
Open in desktop

This file was deleted.

10 changes: 5 additions & 5 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,15 @@
<!-- HTML-Body ================================================================================ -->

<body>
<section id="abstract" data-include-format="markdown" data-include="Abstract v1.0.md"></section>
<section id="abstract" data-include-format="markdown" data-include="Abstract.md"></section>
<section id="sotd"></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-include-format="markdown" class="informative" data-include="Introduction v1.0.md"></section>
<section data-include-format="markdown" data-include="Summary v1.0.md"></section>
<section data-include-format="markdown" data-include="The Design Rules v1.0.md"></section>
<section data-include-format="markdown" data-include="Glossary v1.0.md"></section>
<section data-include-format="markdown" class="informative" data-include="Introduction.md"></section>
<section data-include-format="markdown" data-include="Summary.md"></section>
<section data-include-format="markdown" data-include="DesignRules.md"></section>
<section data-include-format="markdown" data-include="Glossary.md"></section>
</body>

</html>
17 changes: 14 additions & 3 deletions js/config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,16 +9,17 @@
//-------------------------------------------------------------------------------------
//-- Log . . . : 20180615 - FT - Initiele versie
//-- . . . . . : 20181106 - JvG - verplaatst naar root KP-APIs
//-- . . . . . : 20220125 - MvdP - Nieuwe versie / opzet in lijn met de modulaire opbouw
//-------------------------------------------------------------------------------------

var respecConfig =
{
specStatus: "DEF",
specStatus: "WV",
specType: "ST",
pubDomain: "api",
shortName: "adr",
publishDate: "2020-07-09",
publishVersion: "1.0",
publishDate: "2022-01-25",
publishVersion: "1.1",
// previousPublishVersion: "(none)",

// postProcess: [repair],
Expand All @@ -35,6 +36,16 @@ var respecConfig =
name: "Jan van Gelder",
company: "Geonovum",
companyURL: "https://www.geonovum.nl",
},
{
name: "Alexander Green",
company: "Logius",
companyURL: "https://www.logius.nl",
},
{
name: "Martin van der Plas",
company: "Logius",
companyURL: "https://www.logius.nl",
}
],
authors:
Expand Down