925.41 - DFDG swaggerformat standardiseres

Beskrivelse af epic af it-understøttelse af Styrelsen for Arbejdsmarked og Rekrutterings forretning


STAR Projektleder (PL)Forretningsanalytiker (FA)STAR ReleaseEpic statusEksterne snitflader
Knud de Place (STAR)Jesper Brunholm2023-11.0KSS(t.o.), A-kasse(t.o.)



Dette indhold kan ikke ses af eksterne (og er ikke relevant for eksterne)

key po fa ux sme eksterne snitflader interne snitflader status labels
Loading...
Refresh

DS-10819 - Getting issue details... STATUS


Indholdsfortegnelse




Afgrænsning af epic

Afgrænsning

Som systemejer ønsker jeg, at DFDGs REST services repræsenteres med standardoverholdende swaggerfiler uden at dette foranlediger forretningsmæssige snitfladeændringer i swaggerfilerne 

Acceptkriterier

Nr.BeskrivelseRelevant for (interne links)
925.41.1DFDGs grundlægende swaggerformat tilrettes, så det overholder standard og gængse arkitekturnormer for formatet.

DFDG, Jobnet, Vitas

Pilot i JobSearch: 

DS-10843 - Getting issue details... STATUS

Udbredelse til øvrige domæner: 

DS-10851 - Getting issue details... STATUS

925.41.2Implementationen af især kodeliste-repræsentationen i REST services tilpasses, så autogenerering ud fra swaggerfilerne i højere grad er muligDFDG, Jobnet, Vitas
925.41.3Implementationerne sker uden forretningsmæssige implikationer på snitfladerne, og sker dermed uden versionsløftDFDG, Jobnet, Vitas
Kriterier for tilsagn til serviceaftager i forhold til STARs snitfladerBerørte acceptkriterierBemærkninger

925.41.1925.41.2925.41.3

Serviceaftagere er bekendte med at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - og at disse foretages uden versionsløft af de pågældende servicesxxx








Oversigt over berørte webservices 

Manuel oversigt som er synlig for eksterne

Links i listen virker kun med STAR Jira konto og kan derfor ikke tilgås af eksterne. Links under Summary indeholder ikke andre oplysninger relevant for eksterne end hvad der fremgår af tabellen.

Swaggerfiler for alle udstillede REST services berøres. Der er ingen forretningsmæssige ændringer

Manuel oversigt som er synlig for eksterne

Links i listen virker kun med STAR Jira konto og kan derfor ikke tilgås af eksterne. Links under Summary indeholder ikke andre oplysninger relevant for eksterne end hvad der fremgår af tabellen.

Summary
Varslingstype
Varslingsnote
Eksterne Snitflader
Interne Snitflader
Project
Borgerkommunikation.BorgerkommunikationStatusService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Borgerkommunikation.FagprofessionelKontaktService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
EksterneData.SUoplysningsService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftKSSN/AD+S
EksterneData.UddannelsesinstitutionService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftKSSN/AD+S
JobSearch.CvEventService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftN/AN/AD+S
JobSearch.CvPresentationService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
JobSearch.CvSearchService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftKSSJobnetD+S
JobSearch.CvService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
JobSearch.CvSoegeService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
JobSearch.CvWorkFlowService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
JobSearch.JoboenskeService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
JobSearch.LetAsylCVService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftKSSJobnetD+S
JobSearch.PersonJobSearchStatus (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Kontaktforloeb.BorgerBookingService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftPlannersystemerJobnetD+S
Kontaktforloeb.FristService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftKSSJobnetD+S
Kontaktforloeb.IndkaldelseService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Kontaktforloeb.JobnetBookingService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftN/AJobnetD+S
Kontaktforloeb.KontaktforloebStatusService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftN/AJobnetD+S
Taxonomy.EscoStarService (alle).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Taxonomy.SpecialEscoStarHierarkiService (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Virksomhedsindsats.Virksomhedsbrugerkonto (version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSJobnetD+S
Ydelsesudstilling.ForsoergelseshistorikService (Version 1).GetforsoergelseshistorikAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftA-kasse, KSSN/AD+S
Ydelsesudstilling.PensionsdataService (Version 1).AlleAndetServiceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløftUDKN/AD+S

Automatisk oversigt 

Ikke synlig for eksterne, men indeholder ikke andre oplysninger end kopieret til den manuelle oversigt ovenfor.

summary varslingstype varslingsnote eksterne snitflader interne snitflader project
Loading...
Refresh


Beskrivelse af epic

Baggrund

Tiltaget har ingen lovgivningsmæssig baggrund.

Flere aftagere har gennem Fogbugz og ad anden vej gjort opmærksom på, at DFDGs swaggerfiler generelt, og ift. i særdeleshed extensions, ikke er i overensstemmelse med god praksis på området, og dermed besværliggør brugen unødigt for aftagere. Dette vil vi gerne råde bod på.

Der er bl.a. tale om følgende sager:

285508/Udokumenterede-felter-i-swagger-specifikation

284346/Swagger-specifikation-er-ikke-valid

276086/Enums-kodelister-kan-ikke-fremst-nullable-i-swagger-kontrakten-som-aftagere-autogenererer-ud-fra

For at undvige snitfladeændringer sker der ikke ændringer på metodetyper (GET/POST/ osv). Disse rettes i stedet ved førstkommende serviceændring med serviceløft, og en mere RESTful arkitektur indføres med nyudviklede services.

Regler

Her udfylder PO oplysninger om eksisterende eller forventede regler om registrering og indberetning.


Forventet påvirkning af jobcenter-, a-kasse- eller ydelsessystemer

Her beskriver PO overordnet, hvordan epic'en forventes at påvirke aftagerne. Særligt vigtigt, at dette fremgår, hvis det ikke fremgår i en overliggende ISB, hvortil der evt. kan henvises.

A-kasser, KSS og Planner-systemer vil muligvis skulle (gen-initiere ¤hvad er det rigtige ord her?) swaggerfiler. Ændringerne forventes dog at være bagudkompatible.


AC 925.41.1 - DFDGs grundlægende swaggerformat tilrettes, så det overholder standard og gængse arkitekturnormer for formatet

Hovedindsatsen bliver, at extensions prefixes med "x-" med henblik på at overholde standarden for swaggerfiler

AC 925.41.2 - Implementationen af især kodeliste-repræsentationen i REST services tilpasses, så autogenerering ud fra swaggerfilerne i højere grad er mulig

Kodelister repræsenteres kun som optionelle, når de faktisk er optionelle at udfylde.

AC 925.41.3 Implementationerne sker uden forretningsmæssige implikationer på snitfladerne, og sker dermed uden versionsløft

Der sker ingen forretningsmæssige ændringer i de berørte swaggerfiler.



Særlige krav til test

Test scenarieBerørte systemområder (herunder nye batchjobs*) Identificeret af






* Batchjobs

  • bør testes både med delta og fuldt load,
  • bør hvis der er afhængigheder køres med normalt load fra BI i ét testmiljø i hele testperioden
  • bør testes i samarbejde med teams som har afhængigheder
  • kørselstid, særligt hvis det er en del af NightlyBatch


Konsekvenser for drift/idriftsættelse

I forbindelse med idriftsættelse:

  • Skal der køres et fuldt dataload ved første kørsel af et batchjob - aftal med SF hvornår load skal køres
  • skal der køres konvertering
  • Skal der køres databasescripts for opdatering af tabeller i databasen

Efter idriftsættelse:


Arkitektur- og implementeringsnoter 

Her beskriver PO/FA om arkitekturen og teknikken bag løsningen, om der f.eks. anvendes:

  • Nye dataområder
  • Nye snitflader
  • Nye komponenter
  • Nye miljøer
  • Nye teknologier
  • Nye aftagertyper
  • Eller afvigelser fra principperne
  • Eventuelle behov for reduktion af teknisk gæld skal afdækkes


Der gives en beskrivelse af hvorledes disse tænkes håndteret/implementeret i løsningen og om dette har været vendt med STAR arkitekten.