VNG-Realisatie / vng-api-common

Gedeelde code voor RESTful APIs
5 stars 12 forks source link

Tags in schema. #112

Closed joeribekker closed 5 years ago

joeribekker commented 5 years ago

Impact op Zaken API:

tags:
- name: _zoek
  description: 'Een zaak mag (in principe) niet meer gewijzigd worden als de

    `archiefstatus` een andere status heeft dan "nog_te_archiveren". Voor

    praktische redenen is er geen harde validatie regel aan de provider kant.'
- name: klantcontacten
  description: ''
- name: resultaten
  description: ''
- name: rollen
  description: ''
- name: statussen
  description: ''
- name: zaakinformatieobjecten
  description: ''
- name: zaakobjecten
  description: ''
- name: zaken
  description: 'Een zaak mag (in principe) niet meer gewijzigd worden als de

    `archiefstatus` een andere status heeft dan "nog_te_archiveren". Voor

    praktische redenen is er geen harde validatie regel aan de provider kant.'

Impact op Catalogi API:

tags:
- name: besluittypen
  description: 'Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van
    het

    zaakgericht werken van de behandelende organisatie(s).'
- name: catalogussen
  description: "De verzameling van ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn\
    \ voor\neen domein die als \xE9\xE9n geheel beheerd wordt."
- name: eigenschappen
  description: 'Een relevant inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE

    geregistreerd moet kunnen worden en geen standaard kenmerk is van een zaak.'
- name: informatieobjecttypen
  description: 'Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van een document
    of

    ander object dat informatie bevat.'
- name: resultaattypen
  description: 'Het betreft de indeling of groepering van resultaten van zaken van
    hetzelfde

    ZAAKTYPE naar hun aard, zoals ''verleend'', ''geweigerd'', ''verwerkt'', etc.'
- name: roltypen
  description: 'Generieke aanduiding van de aard van een ROL die een BETROKKENE kan

    uitoefenen in ZAAKen van een ZAAKTYPE.'
- name: statustypen
  description: Generieke aanduiding van de aard van een status.
- name: zaaktype-informatieobjecttypen
  description: 'Geeft aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk
    zijn en

    hoe de richting is.'
- name: zaaktypen
  description: 'Een ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen
    van

    zaken van eenzelfde soort.'
codecov-io commented 5 years ago

Codecov Report

Merging #112 into master will increase coverage by 8.37%. The diff coverage is 88.23%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #112      +/-   ##
==========================================
+ Coverage    38.2%   46.58%   +8.37%     
==========================================
  Files          63       63              
  Lines        2209     2226      +17     
  Branches      328      332       +4     
==========================================
+ Hits          844     1037     +193     
+ Misses       1329     1133     -196     
- Partials       36       56      +20
Impacted Files Coverage Δ
vng_api_common/generators.py 90% <88.23%> (+56.66%) :arrow_up:
vng_api_common/notifications/api/views.py 73.52% <0%> (+2.94%) :arrow_up:
vng_api_common/inspectors/polymorphic.py 35.71% <0%> (+7.14%) :arrow_up:
vng_api_common/inspectors/query.py 38.46% <0%> (+7.69%) :arrow_up:
vng_api_common/inspectors/cache.py 100% <0%> (+20%) :arrow_up:
vng_api_common/inspectors/fields.py 54.54% <0%> (+20.45%) :arrow_up:
vng_api_common/search.py 54.54% <0%> (+22.72%) :arrow_up:
vng_api_common/audittrails/viewsets.py 38.46% <0%> (+38.46%) :arrow_up:
vng_api_common/caching/introspection.py 80% <0%> (+40%) :arrow_up:
vng_api_common/inspectors/view.py 72.37% <0%> (+45.3%) :arrow_up:
... and 3 more

Continue to review full report at Codecov.

Legend - Click here to learn more Δ = absolute <relative> (impact), ø = not affected, ? = missing data Powered by Codecov. Last update 34cebcc...1e9a832. Read the comment docs.

sergei-maertens commented 5 years ago

@joeribekker the impact on the _zoek tag is a bit strange, no?

joeribekker commented 5 years ago

Klopt, dat is een actie op de ViewSet zaken. Ik kan daar nog wel een uitzondering voor toevoegen, dat acties hun eigen "description" kunnen krijgen. Is dat denk je voldoende?

sergei-maertens commented 5 years ago

@joeribekker yeah, I think those should be pulled from the action method docstring, that's also how yasg works :thinking: