rest-api-profil-lint-processor/publiccode.yml at a2900b28704faf578ed6be2ebbbfd8d0d1b3a7c1 · diggsweden/rest-api-profil-lint-processor · 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
# SPDX-FileCopyrightText: 2025 diggsweden/rest-api-profil-lint-processor
#
# SPDX-License-Identifier: CC0-1.0

# This repository adheres to the publiccode.yml standard by including this
# metadata file that makes public software easily discoverable.
# More info at https://github.com/italia/publiccode.yml

publiccodeYmlVersion: '0.4.0'
categories:
  - application-development
  - it-development
  - compliance-management
  - test-management
description:
  en:
    features:
      - Schema validation
      - Ensure adherence to OpenAPI standards
      - Missing attributes check
      - Detect missing or misconfigured attributes in specifications
    longDescription: |
      RAP-LP (REST API Profile Lint Processor) is a tool that reviews an OpenAPI specification against the national REST API Profile. The tool identifies syntax errors and deviations from the guidelines, making it easier to quickly find and correct issues.
      The tool analyzes the OpenAPI specification and checks that the API follows specific design rules associated with the REST API Profile. Each rule points to a specific part of the OpenAPI specification using a JSON Path Plus expression and verifies whether the values comply with the established rules. If deviations are found, one or more error messages are returned.
      In addition to the rules from the REST API Profile, RAP-LP also includes a rule area called Prerequisites. This area encompasses additional rules not included in the profile but based on established best practices for API design. The rules in Prerequisites can help further improve the quality of the API specification by identifying areas for improvement not covered by the national profile.
      The first version of RAP-LP is compatible with REST API Profile version 1.2.0, and each new version of the tool will specify which version of the profile it is intended to support.
    shortDescription: A linting tool for the swedish rest api-profile specification
developmentStatus: beta
legal:
  license: EUPL-1.2
localisation:
  availableLanguages:
    - sv
  localisationReady: false
maintenance:
  contacts:
    - name: raplp-maintenance@digg.se
  type: internal
name: 'REST API-profil - Lint Processor (RAP-LP)'
platforms:
  - windows
  - mac
  - linux
releaseDate: '2025-05-17'
softwareType: 'library'
softwareVersion: '1.0.0'
url: 'https://github.com/diggsweden/rest-api-profil-lint-processor.git'