Skip to main content
Version:
2.13.0
Source:

https://github.com/maykinmedia/commonground-api-common

PythonVersion:

3.12

Build status Code quality checks Coverage status Documentation Status Ruff

python-versions django-versions pypi-version

Commonground-API-common biedt generieke implementaties en tooling voor RESTful APIs in een Common Ground gegevenslandschap.

Dit project is een fork van commonground-api-common.

Zie de uitgebreide documentatie voor de features en het gebruik.

1 Features

  • Centraal beheer van constanten die de verschillende componenten overstijgen

  • GeoJSON OpenAPI definities

  • Support voor Geo CRS negotation

  • Ingebouwde support voor nested viewsets met declaratievere syntax voor registratie

  • Vaak voorkomende validators:
    • RSIN/BSN validator

    • Numerieke waarde validator

    • Niet-negatieve waarde validator

    • Alfanumerieke waarde (zonder diacritics)

    • URL-validator (test dat URL bestaat) met pluggable link-checker

    • UntilNowValidator - valideer datetimes tot en met nu. (Via de TIME_LEEWAY setting kan speling worden toegevoegd)

    • UniekeIdentificatieValidator (in combinatie met organisatie)

    • InformatieObjectUniqueValidator om te valideren dat M2M entries slechts eenmalig voorkomen

    • IsImmutableValidator - valideer dat bepaalde velden niet gewijzigd worden bij een (partial) update, maar wel mogen gezet worden bij een create

    • ResourceValidator - valideer dat een URL een bepaalde resource ontsluit

  • Custom inspectors voor drf-yasg:
    • Support voor rest_framework_gis GeometryField

    • SUpport voor django-extra-fields Base64FieldMixin

    • URL-based related resource filtering (django-filter support)

    • verzameling van mogelijke error-responses per operation

  • Management command generate_swagger overloaded
    • neemt default versie mee en maakt server-informatie domein-agnostisch

    • optie om informatiemodel-resources naar markdown te renderen met backlinks naar gemmaonline.nl

  • Support voor ISO 8601 durations

  • Custom model fields:
    • RSINField

    • BSNField

    • LanguageField

    • VertrouwelijkheidsAanduidingField

    • DaysDurationField

  • Mocks voor de validators die netwerk IO hebben, eenvoudig via @override_settings toe te passen

  • Test utilities

  • Optionele notificaties applicatie:
    • ontvangen van webhook events

    • configureren en registreren van notificatiecomponent/webhooks

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

commonground_api_common-2.13.0.tar.gz (1.4 MB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

commonground_api_common-2.13.0-py3-none-any.whl (1.5 MB view details)

Uploaded Python 3

File details

Details for the file commonground_api_common-2.13.0.tar.gz.

File metadata

File hashes

Hashes for commonground_api_common-2.13.0.tar.gz
Algorithm Hash digest
SHA256 1c991cc239f69eba71c69badb2978b634aca53d98fdb52002aabaab088e9bde9
MD5 8a6c80a5cec4c5cd1191d53c984be3b2
BLAKE2b-256 34a7f223677fe3880ee84dcd2daead579cc3b765344961352d9066d8613fdd3b

See more details on using hashes here.

Provenance

The following attestation bundles were made for commonground_api_common-2.13.0.tar.gz:

Publisher: ci.yml on maykinmedia/commonground-api-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file commonground_api_common-2.13.0-py3-none-any.whl.

File metadata

File hashes

Hashes for commonground_api_common-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 a47a3e25eb5868addba36c4ef4455ed54f258e670c00c890280d203fcca8ab89
MD5 c25cb476ba0b03495ece64111c0c237e
BLAKE2b-256 892b5e486ecf355d995e2bcb9f51f5d4c9a5167ffa845ff8d90de908b0be4f95

See more details on using hashes here.

Provenance

The following attestation bundles were made for commonground_api_common-2.13.0-py3-none-any.whl:

Publisher: ci.yml on maykinmedia/commonground-api-common

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Release history Release notifications | RSS feed

2.14.0

2 files

This release

2.13.0 This release

2 files

2.12.0

2 files

2.11.0

2 files

2.10.7

2 files

2.10.6

2 files

2.10.5

2 files

2.10.4

2 files

2.10.3

2 files

2.10.2

2 files

2.10.1

2 files

2.10.0

2 files

2.9.0

2 files

2.8.0

2 files

2.7.0

2 files

2.6.7

2 files

2.6.6

2 files

2.6.5

2 files

2.6.4

2 files

2.6.3

2 files

2.6.2

2 files

2.6.1

2 files

2.6.0

2 files

2.5.5

2 files

2.5.4

2 files

2.5.3

2 files

2.5.2

2 files

2.5.1

2 files

2.5.0

2 files

2.4.1

2 files

2.4.0

2 files

2.3.0

2 files

2.2.0

2 files

2.1.2

2 files

2.1.0

2 files

2.0.1

2 files

2.0.0

2 files

1.13.4

2 files

1.13.3

2 files

1.13.2

2 files

1.13.1

2 files

1.13.0

2 files

1.12.2

2 files

1.12.1

2 files

1.12.0

2 files

1.11.0

2 files

1.10.2

2 files

1.10.1

2 files

1.10.0

2 files

1.9.0

2 files

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page