don-tools-api/publiccode.yml at main · developer-overheid-nl/don-tools-api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
publiccodeYmlVersion: "0.5"

name: DON Tools API
url: https://github.com/developer-overheid-nl/don-tools-api
landingURL: https://apis.developer.overheid.nl

categories:
  - it-development

softwareType: standalone/backend

platforms:
  - web

developmentStatus: stable

description:
  nl:
    shortDescription: >-
      API van het developer.overheid.nl toolsplatform voor het verwerken en
      valideren van OpenAPI-specificaties.
    longDescription: |
      De DON Tools API is de backend API van het developer.overheid.nl
      toolsplatform (apis.developer.overheid.nl). De API biedt functionaliteit
      voor het verwerken, converteren en valideren van OpenAPI-specificaties.
      Ontwikkelaars kunnen via deze API OpenAPI-specificaties omzetten tussen
      versies (3.0 en 3.1), specificaties bundelen, valideren tegen de DON API
      Design Rules (ADR) ruleset, Postman-collecties genereren en
      Arazzo-workflows visualiseren. De API is gebouwd met Node.js en Express
      en volgt een API-first aanpak waarbij het OpenAPI-contract leidend is
      voor de implementatie.
    features:
      - OpenAPI specificatie conversie tussen versie 3.0 en 3.1
      - OpenAPI specificatie bundeling met oplossen van externe verwijzingen
      - OpenAPI specificatie validatie tegen de DON API Design Rules (ADR) ruleset
      - Boilerplate OpenAPI specificatie genereren op basis van JSON-invoer
      - Postman collectie genereren vanuit een OpenAPI specificatie
      - Arazzo workflow visualisatie als Mermaid-diagram of Markdown

legal:
  license: EUPL-1.2
  mainCopyrightOwner: Geonovum

intendedAudience:
  countries:
    - NL
  scope:
    - government

localisation:
  availableLanguages:
    - nl
    - en
  localisationReady: false

maintenance:
  type: internal
  contacts:
    - name: Team developer.overheid.nl
      email: developer.overheid@geonovum.nl
      affiliation: Geonovum