eho/atomic-design-poc
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
94ffcf3d415e08922b957a0514365ba6481d4b83
atomic-design-poc/backend/swagger.json
Edwin van den Houdt d08f3877f7 Architect-review remediation: enforce conventions, prod-safe tooling, one form idiom, resilience seams 
Acts on the showcase review. Four workstreams; all tests green
(npm run lint, 70 FE tests, ng build, 33 backend tests).

Enforcement + CI:
- eslint.config.mjs bans `any` and enforces layer/context boundaries
  (domain ≠ Angular; herregistratie → registratie → shared, auth → shared);
  `npm run lint` added; ajv 6 scoped to ESLint via nested override.
- .github/workflows/ci.yml: FE lint+check:tokens+test+build, backend dotnet test,
  and an API-client drift check.

One form idiom (the headline finding):
- change-request-form converged onto the wizard pattern — change-request.machine.ts
  (Model/Msg/reduce + value objects) + submit-change-request.ts (Result) + a real
  POST /api/v1/change-requests (server re-validates). Spec + story added; the detail
  page no longer holds an ad-hoc success signal.

Resilience/observability seam:
- api-client.provider.ts: request timeout, X-Correlation-Id, Idempotency-Key for
  writes; comments naming the retry/auth seams.
- Backend logs correlation id + a no-PII submit-audit line; /api/v1 prefix +
  backward-compat note; client regenerated.

Quick wins:
- Dev tooling excluded from prod: scenario.interceptor wired only under isDevMode()
  (?scenario= inert in prod); debug panel @if(isDev) (tree-shaken out).
- src/environments + apiBaseUrl into provideApiClient (angular.json fileReplacements).
- Backend /health + /health/ready.
- Debug view PII-minimised (redactProfile: name/address/DOB redacted, BIG masked).
- IntakePolicyAdapter (removes inline resource in the intake wizard).
- README de-staled; CLAUDE.md gains EN/NL + forms-one-idiom + lint/CI notes.
- Stories: text-input, link, data-row, site-header, site-footer, change-request-form.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
2026-06-27 08:25:51 +02:00

626 lines
15 KiB
JSON
Raw Blame History

{
"openapi": "3.0.4",
"info": {
"title": "BIG-register BFF",
"version": "v1"
},
"paths": {
"/health": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/health/ready": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK"
}
}
}
},
"/api/v1/dashboard-view": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardViewDto"
}
}
}
}
}
}
},
"/api/v1/notes": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AantekeningDto"
}
}
}
}
}
}
}
},
"/api/v1/brp/address": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrpAddressDto"
}
}
}
}
}
}
},
"/api/v1/duo/diplomas": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DuoLookupDto"
}
}
}
}
}
}
},
"/api/v1/intake/policy": {
"get": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntakePolicyDto"
}
}
}
}
}
}
},
"/api/v1/registrations": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RegistratieRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/herregistraties": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/HerregistratieRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/intakes": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/IntakeRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
},
"/api/v1/change-requests": {
"post": {
"tags": [
"BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangeRequestRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ReferentieResponse"
}
}
}
},
"422": {
"description": "Unprocessable Content",
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ProblemDetails"
}
}
}
}
}
}
}
},
"components": {
"schemas": {
"AantekeningDto": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"omschrijving": {
"type": "string",
"nullable": true
},
"datum": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"AdresDto": {
"type": "object",
"properties": {
"straat": {
"type": "string",
"nullable": true
},
"postcode": {
"type": "string",
"nullable": true
},
"woonplaats": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"BrpAddressDto": {
"type": "object",
"properties": {
"gevonden": {
"type": "boolean"
},
"adres": {
"$ref": "#/components/schemas/AdresDto"
}
},
"additionalProperties": false
},
"ChangeRequestRequest": {
"type": "object",
"properties": {
"straat": {
"type": "string",
"nullable": true
},
"postcode": {
"type": "string",
"nullable": true
},
"woonplaats": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"DashboardViewDto": {
"type": "object",
"properties": {
"registration": {
"$ref": "#/components/schemas/RegistrationDto"
},
"person": {
"$ref": "#/components/schemas/PersonDto"
},
"decisions": {
"$ref": "#/components/schemas/HerregistratieDecisionsDto"
}
},
"additionalProperties": false
},
"DuoDiplomaDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"naam": {
"type": "string",
"nullable": true
},
"instelling": {
"type": "string",
"nullable": true
},
"jaar": {
"type": "integer",
"format": "int32"
},
"beroep": {
"type": "string",
"nullable": true
},
"policyQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyQuestionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"DuoLookupDto": {
"type": "object",
"properties": {
"diplomas": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DuoDiplomaDto"
},
"nullable": true
},
"handmatig": {
"$ref": "#/components/schemas/ManualDiplomaPolicyDto"
}
},
"additionalProperties": false
},
"HerregistratieDecisionsDto": {
"type": "object",
"properties": {
"eligibleForHerregistratie": {
"type": "boolean"
},
"herregistratieReason": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"HerregistratieRequest": {
"type": "object",
"properties": {
"uren": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IntakePolicyDto": {
"type": "object",
"properties": {
"scholingThreshold": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"IntakeRequest": {
"type": "object",
"properties": {
"uren": {
"type": "integer",
"format": "int32"
}
},
"additionalProperties": false
},
"ManualDiplomaPolicyDto": {
"type": "object",
"properties": {
"beroepen": {
"type": "array",
"items": {
"type": "string"
},
"nullable": true
},
"policyQuestions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PolicyQuestionDto"
},
"nullable": true
}
},
"additionalProperties": false
},
"PersonDto": {
"type": "object",
"properties": {
"naam": {
"type": "string",
"nullable": true
},
"geboortedatum": {
"type": "string",
"nullable": true
},
"adres": {
"$ref": "#/components/schemas/AdresDto"
}
},
"additionalProperties": false
},
"PolicyQuestionDto": {
"type": "object",
"properties": {
"id": {
"type": "string",
"nullable": true
},
"vraag": {
"type": "string",
"nullable": true
},
"type": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"ProblemDetails": {
"type": "object",
"properties": {
"type": {
"type": "string",
"nullable": true
},
"title": {
"type": "string",
"nullable": true
},
"status": {
"type": "integer",
"format": "int32",
"nullable": true
},
"detail": {
"type": "string",
"nullable": true
},
"instance": {
"type": "string",
"nullable": true
}
},
"additionalProperties": { }
},
"ReferentieResponse": {
"type": "object",
"properties": {
"referentie": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RegistratieRequest": {
"type": "object",
"properties": {
"diplomaHerkomst": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
},
"RegistrationDto": {
"type": "object",
"properties": {
"bigNummer": {
"type": "string",
"nullable": true
},
"naam": {
"type": "string",
"nullable": true
},
"beroep": {
"type": "string",
"nullable": true
},
"registratiedatum": {
"type": "string",
"nullable": true
},
"geboortedatum": {
"type": "string",
"nullable": true
},
"status": {
"$ref": "#/components/schemas/RegistrationStatusDto"
}
},
"additionalProperties": false
},
"RegistrationStatusDto": {
"type": "object",
"properties": {
"tag": {
"type": "string",
"nullable": true
},
"herregistratieDatum": {
"type": "string",
"nullable": true
},
"geschorstTot": {
"type": "string",
"nullable": true
},
"reden": {
"type": "string",
"nullable": true
},
"doorgehaaldOp": {
"type": "string",
"nullable": true
}
},
"additionalProperties": false
}
}
},
"tags": [
{
"name": "BigRegister.Api, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null"
}
]
}
Reference in New Issue View Git Blame Copy Permalink