Skip to content

Commit a2900b2

Browse files
chore: update publiccode
Signed-off-by: Nicklas Silversved <nicklas.silversved@digg.se>
1 parent 56ff944 commit a2900b2

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

publiccode.yml

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,10 @@ description:
2020
- Missing attributes check
2121
- Detect missing or misconfigured attributes in specifications
2222
longDescription: |
23-
REST API-profil - Lint Processor is a command-line tool to lint OpenAPI v3 definitions of the swedish rest api-profile specification using Spectral.
23+
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.
24+
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.
25+
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.
26+
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.
2427
shortDescription: A linting tool for the swedish rest api-profile specification
2528
developmentStatus: beta
2629
legal:
@@ -31,8 +34,7 @@ localisation:
3134
localisationReady: false
3235
maintenance:
3336
contacts:
34-
- name: Digg OSPO
35-
- email: 'raplp-maintenance@digg.se'
37+
- name: raplp-maintenance@digg.se
3638
type: internal
3739
name: 'REST API-profil - Lint Processor (RAP-LP)'
3840
platforms:

0 commit comments

Comments
 (0)