Altinn / altinn-decision-log

Log for architecture and design/ux decisions across Altinn teams and products
0 stars 0 forks source link

Common API Patterns for Altinn #4

Open TheTechArch opened 6 months ago

TheTechArch commented 6 months ago

Status

Proposed

Context

There are several patterns on API design we might want to have a common decision on

Decision

Naming of API based on consumer of the API

Should we name API based on consumer of those API. Like ServiceOwnerRoles, GetDataServiceOwner,

Error codes

How should we standardize for returning error codes from API

APIM Products

How should we setup products

O data filtering

Should we use O-Data in filtering?

Consequences

What becomes easier or more difficult to do because of this change?