Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Als vakapplicatieontwikkelaar wil ik weten hoe error-responses eruit zien... #130

Closed
19 tasks done
sergei-maertens opened this issue Jun 8, 2018 · 6 comments
Closed
19 tasks done

Als vakapplicatieontwikkelaar wil ik weten hoe error-responses eruit zien... #130

sergei-maertens opened this issue Jun 8, 2018 · 6 comments
Assignees
@sergei-maertens @HenriKorver
Labels
DSO Digitaal Stelsel Omgevingswet - Rotterdam, Delft Non functional requirement NFR's
Milestone
Sprint 3

Comments

@sergei-maertens
Copy link
Collaborator

sergei-maertens commented Jun 8, 2018 •
edited
Loading

...zodat ik deze consistent in mijn applicatie kan verwerken.

PR: #360

Definition of done

  • er is een OAS 3.0 specificatie, afgestemd met leveranciers van ZRC/e-Suite
  • de specificatie is gepubliceerd leesbaar
  • er is een referentieimplementatie
  • er is functionele documentatie conform het DSO-patroon
  • de DSO URI- en API-strategie worden gevolgd

Acceptatiecriteria

Uit de algemene uitgangspunten:

  • Voldoet aan RGBZ 2.0 n.v.t.
  • Voldoet aan GEMMA 2.0 n.v.t.
  • De foutmeldingen hebben een uniforme structuur
  • De foutmeldingen zijn gedocumenteerd:
    • HTTP 400 validatiefouten
    • HTTP 401
    • HTTP 403
    • HTTP 404
    • HTTP 405
    • HTTP 422

Taken
@sergei-maertens sergei-maertens added verbetering DSO Digitaal Stelsel Omgevingswet - Rotterdam, Delft labels Jun 8, 2018
@sergei-maertens sergei-maertens self-assigned this Jun 8, 2018
This was referenced Jun 8, 2018
Merged
Merged
@EdwinCoster EdwinCoster added this to the Sprint 2 milestone Jun 20, 2018
@TCIMEddy
Copy link
Contributor

Hoi Sergei en ervaringsdeskundige Scrum, volgens mij voldoet deze user story aan de DoR?
schermafbeelding 2018-06-25 om 11 22 02

@sergei-maertens
Copy link
Collaborator Author

@TCIMEddy yep, het puntje 'architectuur schetsje' is hier niet van toepassing.

@ehotting ehotting modified the milestones: Sprint 2, Sprint 3 Aug 3, 2018
@sergei-maertens
Copy link
Collaborator Author

Vraag uitgezet n.a.v. DSO API-strategie error-formaat: https://forum.pdok.nl/t/formaat-foutafhandeling-input-validatie-api-50/1848

@sergei-maertens
Copy link
Collaborator Author

Antwoorden zijn duidelijk (en worden deels in design-keuzes opgenomen)

  1. Meerdere fouten op zelfde veld bij inputvalidatie: komen allemaal als aparte fout instance terug, in plaats van ze samen te voegen in 1 fout
  2. Er worden basic HTML pagina's gebouwd die informatie over de fouten bevatten. Doelpubliek hiervoor is per de RFC developers, en dient NIET om automatische systeemafhandeling mee te doen.

sergei-maertens added a commit that referenced this issue Aug 30, 2018
@sergei-maertens
Ref #130 -- Documenteer meerdere validatiefouten responses
e35f299
sergei-maertens added a commit to VNG-Realisatie/documenten-api that referenced this issue Aug 30, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
71f3f56 
Conform aan ZRC implementatie, neem de mogelijke foutantwoorden op in de
`openapi.yaml` spec.

Ook is dezelfde styling van foutpagina's overnomen uit het ZRC.
sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Aug 30, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
ddff21b
sergei-maertens added a commit that referenced this issue Sep 3, 2018
@sergei-maertens
Ref #130 -- Documenteer meerdere validatiefouten responses
c94d924
joeribekker added a commit that referenced this issue Sep 4, 2018
@joeribekker
Merge pull request #343 from VNG-Realisatie/feature/us-130-design-keu…
1e8bd53 
…ze-fouten

Ref #130 -- Documenteer meerdere validatiefouten responses
sergei-maertens added a commit that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. #130 -- documenteer validaties in WIP-standaard
d9f37e0 
Deze PR doet aan aanzet op het document voor de eigenlijke standaard.
Er zijn veel TODOs en er kan vast veel verbeterd worden, maar de
validaties moeten wel tekstueel beschreven zijn om opgenomen te kunnen
worden.
sergei-maertens added a commit to VNG-Realisatie/documenten-api that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
6b45991 
Conform aan ZRC implementatie, neem de mogelijke foutantwoorden op in de
`openapi.yaml` spec.

Ook is dezelfde styling van foutpagina's overnomen uit het ZRC.
sergei-maertens added a commit to VNG-Realisatie/documenten-api that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- valideer geldige informatieobj…
63ea468 
…ecttype URL
sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
2b8f10b
sergei-maertens added a commit that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. #130 -- neem DRC validatie op
57d16e0
sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
5ab1bcd
sergei-maertens added a commit that referenced this issue Sep 5, 2018
@sergei-maertens
Ref. #130 -- update API specs uit referentie-implementaties
fd783cc
@sergei-maertens sergei-maertens mentioned this issue Sep 5, 2018
Merged
4 tasks
@sergei-maertens sergei-maertens mentioned this issue Sep 10, 2018
Closed
24 tasks
sergei-maertens added a commit to VNG-Realisatie/zaken-api that referenced this issue Sep 10, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- regression test for bad invali…
790e604 
…d-params format
@sergei-maertens sergei-maertens mentioned this issue Sep 12, 2018
Closed
12 tasks
@jeffreygortmaker1
Copy link
Contributor

iets voor @zomwoof denk ik

sergei-maertens added a commit to VNG-Realisatie/catalogi-api that referenced this issue Sep 13, 2018
@sergei-maertens
Merge pull request #9 from VNG-Realisatie/feature/us-130-error-responses
3981b49 
Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS
sergei-maertens added a commit that referenced this issue Sep 17, 2018
@sergei-maertens
Merge pull request #360 from VNG-Realisatie/feature/aanzet-standaard
4628de0 
Ref. #130 -- documenteer validaties & fout responses (in WIP-standaard)
@HenriKorver
Copy link
Collaborator

HenriKorver commented Sep 17, 2018 •
edited
Loading

Volgens de DSO API Strategie en de internetstandaard RFC7807 (Problem Details for HTTP APIs) dient het media type bij error-responses application/problem+json te zijn in plaats van application/json.

sergei-maertens added a commit to VNG-Realisatie/vng-api-common that referenced this issue Sep 17, 2018
@sergei-maertens
Ref. VNG-Realisatie/gemma-zaken#130 -- correcte mimetype
3108d75 
Correcte error response MimeType `application/error+json` volgens
DSO API-richtlijnen (dank aan @zomwoof voor de review en opmerken).
sergei-maertens added a commit that referenced this issue Sep 17, 2018
@sergei-maertens
Fixes #130 -- correctie op OpenAPI spec m/b tot mimetype foutberichten
becc287
sergei-maertens added a commit that referenced this issue Sep 19, 2018
@sergei-maertens
Merge pull request #410 from VNG-Realisatie/feature/error-response-mi…
a452008 
…metype

Fixes #130 -- correctie op OpenAPI spec m/b tot mimetype foutberichten
sercanyaldiz added a commit to Amsterdam/gemma-zaaktypecatalogus that referenced this issue Nov 13, 2018
@sercanyaldiz
Ready to deploy from master branch (#3)
2118e8f 
* StatusType.volgnummer toegevoegd t.b.v. VNG-Realisatie#153

* Update API spec n.a.v. API aanpassingen

* Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS

* DSO API-50 tests toegevoegd

* Ref. VNG-Realisatie/gemma-zaken#162 -- clean up BesluitType data model

* Ref. VNG-Realisatie/gemma-zaken#162 -- voeg besluittype toe aan API

* US-162 -- fix tests

* Besluittype tests

* Correcte MIME-types voor error responses

* Fix incorrect content-type

* Set up contrib.sites

* Bump zds-schema version

* Logisch attribuut "isEindstatus" toegevoegd aan StatusType t.b.v. US 351.

* Publicatietekst & toelichting hebben geen lengte-limitatie

Zie: https://github.com/VNG-Realisatie/gemma-zaken/pull/362\#pullrequestreview-168803832

* added initial jenkinsfile

* removed AS production form the last docker phase

* jenkinsfile with new phases

* trigger for branch develop

* fix typo (#1)

* Features/bas 1271 (#2)

* fix typo

* trigger on master branch
sercanyaldiz added a commit to Amsterdam/gemma-zaaktypecatalogus that referenced this issue Jan 9, 2019
@sercanyaldiz
merge branch develop into master (#5)
9fff077 
* StatusType.volgnummer toegevoegd t.b.v. VNG-Realisatie#153

* Update API spec n.a.v. API aanpassingen

* Ref. VNG-Realisatie/gemma-zaken#130 -- mogelijke foutantwoorden in OAS

* DSO API-50 tests toegevoegd

* Ref. VNG-Realisatie/gemma-zaken#162 -- clean up BesluitType data model

* Ref. VNG-Realisatie/gemma-zaken#162 -- voeg besluittype toe aan API

* US-162 -- fix tests

* Besluittype tests

* Correcte MIME-types voor error responses

* Fix incorrect content-type

* Set up contrib.sites

* Bump zds-schema version

* Logisch attribuut "isEindstatus" toegevoegd aan StatusType t.b.v. US 351.

* Publicatietekst & toelichting hebben geen lengte-limitatie

Zie: https://github.com/VNG-Realisatie/gemma-zaken/pull/362\#pullrequestreview-168803832

* added initial jenkinsfile

* removed AS production form the last docker phase

* jenkinsfile with new phases

* trigger for branch develop

* fix typo (#1)

* Features/bas 1271 (#2)

* fix typo

* trigger on master branch

* enabled slack channel and changed the channel

* Merge upstream changes into fork (#4)

* corrected some errors in documentation configuration

* 💥 OAUTH2 out, JWT in

* ✅ Add authorization tests

* 💄 Expose scopes documentation page

* 📝 Put AUTH requirements in API spec

* ⬆️ Bump zds_schema version

* ✨ Set up JWTSecret registration endpoint

* 🔖 Bump version & update changelog

* ✨ Add support for directly serving OAS 3.0.

* 🔖 Bump versie & update changelog 0.5.0 release

* Informatieobjecttypen beschikbaar gemaakt via catalogus.

* Fixes gemma-zaken/#566: Element besluittypen toegevoegd aan zaaktype en beheerbaar gemaakt in admin.

* 🐛 API-50 fix in vorm van foutberichten van zds-schema doorgevoerd

* 🔖 Bump versie & update changelog 0.5.1 release

* 🐛 API-50 fix in vorm van foutberichten van zds-schema doorgevoerd

* 🔖 Bump versie & update changelog 0.5.1 release

* 🐛 Update fixture - remove oauth* things

* ⬆️ Bump naar zds-schema 0.14.0 om JWT decode-problemen correct af te vangen

* ⬆️ Bump naar zds-schema 0.15.2

* ✅ Add test for invalid query params

* ✨ Throw error on invalid params

* ♻️ Gebruik zds_schema NestedViewSetMixin

* 📝 Update API spec

* ⬆️ Bump naar zds-schema 0.16.1

Deze zorgt ervoor dat `Authorization: Bearer <jwt>` herkend wordt.

* 🐳 Parametrize more in Docker

The port that uwsgi should bind to can now be specified as well,
allowing the network mode 'host' to be used in docker-compose

* 🔖 Bump version & update changelog

* ⬆️ Bump to zds-schema 0.17.1

* Fixes missing Location header _when_ we get create operations
* Uses generic APIVersion middleware
* Fixes server URLs in OAS

* 🔖 Bump version & update changelog

* Fixes VNG-Realisatie/gemma-zaken/#593 Changed unicity from generic role description to role description, combined with zaaktype.

* Fixes InformatieObjectTypes as part of the catalogus API

* Added more required scopes.

* 🔒 Lock down permissions in ZTC

* ⬆️ Bump zds-schema fix for api root view

* 🔖 Bump version & update changelog

* ⬆️ Fix zds-schema version

* ⬆️ Update to latest zds-schema fixes

* ✨ Use a session cookie name per services

This fixes being logged out all the time on the same domain when
switching between services

* 🔖 Bump version & update changelog

* 💥 Renamed StatusType.is_van to StatusType.zaaktype

* 💥 Renamed X.maaktDeelUitVan to X.catalogus

* ⬆️ Bump Django and urllib

* urllib3<=1.22 has a CVE
* use latest patch release of Django 2.0

* 🔧 Increase buffer size to accomodate large headers

Java/Spring sends an obnoxiously large Accept-Charset header, proving
to be problematic combined with the bulkiness of JWTs.

* 🐛 Don't compare datetimes with None

* ✨ Add download of fixture data and instructions on how to use it

* 🔖 Bump version & update changelog

* ⬆️ Bump to zds-schema 0.17.9

* 👌 Specify correct title for zaaktype attribute

* 🔖 Version bump & update changelog
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sergei-maertens sergei-maertens

@HenriKorver HenriKorver

Labels
DSO Digitaal Stelsel Omgevingswet - Rotterdam, Delft Non functional requirement NFR's
Projects
None yet
Milestone
Sprint 3
Development

No branches or pull requests
6 participants
@sergei-maertens @ehotting @jeffreygortmaker1 @HenriKorver @TCIMEddy @EdwinCoster