925.41 - DFDG swaggerformat standardiseres
Beskrivelse af epic af it-understøttelse af Styrelsen for Arbejdsmarked og Rekrutterings forretning
Indholdsfortegnelse
Afgrænsning af epic
Kriterier for tilsagn til serviceaftager i forhold til STARs snitflader | Berørte acceptkriterier | Bemærkninger | |||
---|---|---|---|---|---|
925.41.1 | 925.41.2 | 925.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 services | x | x | x | ||
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).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Borgerkommunikation.FagprofessionelKontaktService (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
EksterneData.SUoplysningsService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | KSS | N/A | D+S |
EksterneData.UddannelsesinstitutionService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | KSS | N/A | D+S |
JobSearch.CvEventService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | N/A | N/A | D+S |
JobSearch.CvPresentationService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
JobSearch.CvSearchService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | KSS | Jobnet | D+S |
JobSearch.CvService (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
JobSearch.CvSoegeService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
JobSearch.CvWorkFlowService (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
JobSearch.JoboenskeService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
JobSearch.LetAsylCVService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | KSS | Jobnet | D+S |
JobSearch.PersonJobSearchStatus (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Kontaktforloeb.BorgerBookingService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | Plannersystemer | Jobnet | D+S |
Kontaktforloeb.FristService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | KSS | Jobnet | D+S |
Kontaktforloeb.IndkaldelseService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Kontaktforloeb.JobnetBookingService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | N/A | Jobnet | D+S |
Kontaktforloeb.KontaktforloebStatusService (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | N/A | Jobnet | D+S |
Taxonomy.EscoStarService (alle).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Taxonomy.SpecialEscoStarHierarkiService (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Virksomhedsindsats.Virksomhedsbrugerkonto (version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | Jobnet | D+S |
Ydelsesudstilling.ForsoergelseshistorikService (Version 1).Getforsoergelseshistorik | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | A-kasse, KSS | N/A | D+S |
Ydelsesudstilling.PensionsdataService (Version 1).Alle | Andet | Serviceaftagere er bekendte med, at der kommer mindre, tekniske tilretninger på alle swaggerkontrakter for DFDG REST services - uden versionsløft | UDK | N/A | D+S |
Automatisk oversigt
Ikke synlig for eksterne, men indeholder ikke andre oplysninger end kopieret til den manuelle oversigt ovenfor.
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
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 scenarie | Berø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.