Altinn / Altinn/altinn-authentication

OpenAPI-forbedringer: Access Management – Consent Enterprise API

Open
#2,091 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C#
Stars
8
Forks
5
Avg merge
3d 10h
Merged PRs (30d)
17

Description

## Kontekst

Sub-task under #2089 – Oppdater OpenAPI spec til felles standard.

Spec-fil: `static/swagger/altinn-platform-accessmanagement-v1-consententerprise.json` i `Altinn/altinn-studio-docs`.

## Nåværende tilstand

- **3 operasjoner** – ingen har summary eller description
- **6 parametere mangler description**
- **1 request body mangler description**
- **14 schemas mangler description**
- **41 schema properties mangler description**
- **2 operasjoner mangler security-definisjon**
- **0 eksempler**
- `info.description` mangler

## Operasjoner som må dokumenteres

| Metode | Path | Mangler |
|--------|------|---------|
| POST | `/accessmanagement/api/v1/enterprise/consentrequests` | summary, description, operationId, requestBody description |
| GET | `/accessmanagement/api/v1/enterprise/consentrequests/{consentRequestId}` | summary, description, operationId, param description, security |
| GET | `/accessmanagement/api/v1/enterprise/consentrequests/events` | summary, description, operationId, 5 param descriptions, security |

## Sjekkliste

- [ ] Legg til `info.description`
- [ ] Legg til `summary` og `description` på alle 3 operasjoner
- [ ] Legg til `operationId` på alle 3 operasjoner
- [ ] Legg til `description` på alle 6 parametere
- [ ] Legg til `description` på 1 request body
- [ ] Definer `security` på 2 operasjoner
- [ ] Legg til `description` på alle 14 schemas
- [ ] Legg til `description` på alle 41 schema properties
- [ ] Legg til minst ett eksempel per operasjon

Contributor guide

No contributing guide indexed for this repository

Research direction

Open static/swagger/altinn-platform-accessmanagement-v1-consententerprise.json and review the three listed operations and their schemas. Use issue #2089's shared OpenAPI standard as the reference, then verify that every checklist item is covered: descriptions, operationIds, security definitions, and examples for all operations.

Written by the indexing model from the issue text.

Assessment

Tech stack
openapi
Domain
api, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Clearly specified
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.