VNG-Realisatie / BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen

Documentatie repository voor Individuele Bevragingen API
https://vng-realisatie.github.io/BAG-Gemeentelijke-wensen-tav-BAG-Bevragingen/
5 stars 10 forks source link

Pas de pagina 'Getting Started' voor Huidige Bevragingen API 1.5 aan #556

Closed melsk-r closed 1 year ago

melsk-r commented 1 year ago

Ik heb een melding ontvangen dat op een van de GitHub Pages pagina's de link voor aanvraag API BAG bevragen niet naar een formulier gaat. De betreffende pagina bereik je via ‘https://vng-realisatie.github.io/Haal-Centraal-BAG-bevragen/’ en vervolgens door achtereenvolgens in de side navigatie op de bovenste ‘Getting Started’ en in de pagina op de tekst 'Vraag een API key voor de productieomgeving aan.' te klikken.

Op zich logisch dat je voor versie 1.5 geen API key meer aan kunt vragen, deze is immers deprecated en moet voor 1 juli a.s. vervangen worden door de Individuele Bevragingen. De term Getting Started onder ‘Haal Centraal BAG Huidige Bevragingen v. 1.5 (Deprecated)’ in de side navigatie is in die context wel vreemd. Ik kan me echter voorstellen dat daar nog wel informatie in staat die voor de huidige gebruikers op dit moment nog van belang kan zijn. Ik stel dan ook voor om de site als volgt aan te passen:

• Wijzig het kopje in de side navigatie in ‘Functionaliteit en specificaties’; • Wijzig de titel van de pagina in ‘Functionaliteit en specificaties – BAG Huidige Bevragingen API’; • Verwijder alle tekst na de titel t/m het kopje ‘Functionaliteit en specificaties’ en vervang deze door een waarschuwing; • Verwijder de paragraaf ‘Implementeer de API client’; • Wijzig de titel ‘Probeer en test de API’ in ‘Test de API’, proberen is immers niet meer aan de orde; • Pas de tekst van de paragraaf ‘API key’ aan.

Zie hier voor een voorbeeld van dat wat ik voorstel. Ik hoor graag of jullie je hierin kunnen vinden en welke aanpassingen jullie evt. graag op mijn voorstel zouden aanbrengen.

JohanBoer commented 1 year ago

Ik ben het eens met de voorgestelde wijzigingen. Ik neem aan dat je met de waarschuwing die je in bullet 3 noemt ook bedoelt dat er verwezen wordt naar de individuele bevragingen API van het kadaster.

JohanBoer commented 1 year ago

Zie net de waarschuwing die er op het voorbeeld op jouw repo staat. Lijkt mij uitstekend.

brienen commented 1 year ago

Ik ben het ook eens met de voorgestelde wijziging. Wat mij betreft doorvoeren!

melsk-r commented 1 year ago

Aanpassingen zijn doorgevoerd.