Kapstop issues na het doorlopen van het in-beheer-name-proces

[joeribekker]

Hieronder staan de aantekeningen die ik heb gemaakt na het doorlopen van het in beheer name proces met @michielverhoef .

---

Overdragen van API-development naar API-beheer

NIEUW: Er moet een template komen van hoe een API standaard wordt overgedragen! Nu ontbraken bijvoorbeeld linkjes naar documentatie.
NIEUW: Criteria (checklist) moet ook naar API-developers

Mijn mailtje was nu dit:

Demo API Standaard op Github
https://github.com/maykinmedia/demo-api

Referentie implementatie
https://github.com/maykinmedia/demo-api-component

Docker
https://hub.docker.com/r/vngr/demo-api

Test omgeving
https://ref.tst.vng.cloud/demo-api/api/v2/schema/
https://ref.tst.vng.cloud/demo-api/api/v2/

Alstublieft!

Starten aan API development/design

Beheer helpt API developers/designers door:

NIEUW:

• Beheer geeft toegang tot Dockerhub voor pushen van images aan devs
• Beheer vraagt aan devs: Voordat je oplevert, hang in test platform met deze credentials
• Documenteer altijd bepaalde onderwerpen; als het n.v.t. is, moet dat er ook staan (bijv. afhankelijkheden van andere APIs)
• Mail je standaard naar "..."

Nu begonnen we aan het doorlopen van de criteria:

Criteria

• NIEUW. Er moet een testomgeving draaien van de implementatie.
• Is de standaard (=OAS+document) formeel goedgekeurd, concreet gemaakt:
  • NIEUW: Is er een API-lab geweest van deze API? Nee? Afgekeurd.
  • NIEUW: Zijn er sprint demo's geweest van deze API? Nee? Afgekeurd.
  • NIEUW: Hij moet beschikbaar zijn in test platform
• Is standaard publiekelijk beschikbaar?
  • NIEUW: Is de OAS zonder restricties op te vragen in de browser? Nee? Afgekeurd?
• NIEUW: Kwaliteitscheck op OAS
  • Voldoet hij aan de landelijke API strategie, of is er gedocumenteerd afgeweken
  • Openen in Swaggerhub ter dubbelcheck
• NIEUW: Documentatie heeft minimaal:
  • UML, Is deze er niet? Afgekeurd.
  • Welke gegevens worden er ontsloten: Tabel van de resource + bijzonderheden. Niet? Afgekeurd.
  • INSTALL.rst van de ref. impl.
  • Is er een beschrijving van de Business logica?
  • Changelog er in waar per versie staat wat is teogevoegd, gewijzigd en hoe te migreren
• De ref impl. moet gereed en up to date zijn:
  • NIEUW Steekproef van Openapi.yaml vs test omgeving, vergelijk de resource
  • NIEUW Jenkins er uit
  • NIEUW Docker moet Dockerhub staan binnen een namespace van VNG
  • NIEUW Semver er uit, dit is een randvoorwaarde
  • NIEUW devstraat er uit

Resultaat criteria check

NIEUW: Resultaat wordt terug gemaild, met een lijst van verbeteringen door te voeren OF dat de API in beheer wordt genomen.