Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/maykinmedia/objecttypes-api

API and admin interface to manage object definitions.
https://github.com/maykinmedia/objecttypes-api

commonground

Last synced: 2 months ago
JSON representation

API and admin interface to manage object definitions.

Host: GitHub
URL: https://github.com/maykinmedia/objecttypes-api
Owner: maykinmedia
License: other
Created: 2020-04-14T15:21:48.000Z (almost 5 years ago)
Default Branch: master
Last Pushed: 2024-09-18T14:15:07.000Z (4 months ago)
Last Synced: 2024-09-18T14:51:16.470Z (4 months ago)
Topics: commonground
Language: Python
Homepage: https://opengem.nl/producten/overige-registraties/
Size: 1.42 MB
Stars: 2
Watchers: 4
Forks: 6
Open Issues: 2
Metadata Files:
- Readme: README.NL.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
- Authors: AUTHORS

Awesome Lists containing this project

README

        ===============

Objecttypen API

===============

:Version: 2.2.2

:Source: https://github.com/maykinmedia/objecttypes-api

:Keywords: objecten, assets, zaakobjecten

|docs|

API om object definities te beheren. (`English version`_)

Ontwikkeld door `Maykin Media B.V.`_ in opdracht van de gemeente Utrecht.

Introductie

===========

De Objecttypen API heeft als doel om uiteenlopende typen objecten op een

dynamische wijze te standaardiseren op landelijk niveau en om te voorkomen dat

voor elk (eenvoudig) object een volledige API wordt opgezet.

Deze landelijke Objecttypen API is noodzakelijk voor het registreren van

objecten in lokale `Objecten API's`_. Organisaties kunnen lokaal ook een

Objecttypen API draaien en zo landelijke als lokale definities van objecten

hanteren.

API specificatie

================

|lint-oas| |generate-sdks| |generate-postman-collection|

==============  ==============  =============================

Versie          Release datum   API specificatie

==============  ==============  =============================

latest          n/a             `ReDoc `_,

                                `Swagger `_,

                                (`verschillen `_)

2.2.2           2022-08-23      `ReDoc `_,

                                `Swagger `_

                                (`verschillen `_)

2.2.0           2022-06-24      `ReDoc `_,

                                `Swagger `_

                                (`verschillen `_)

2.0.0           2021-10-04      `ReDoc `_,

                                `Swagger `_

                                (`verschillen `_)

==============  ==============  =============================

Vorige versies worden nog 6 maanden ondersteund nadat de volgende versie is uitgebracht.

Zie: `Alle versies en wijzigingen `_

Referentie implementatie

========================

|build-status| |coverage| |black| |docker| |python-versions|

De referentie implementatie toont de API in actie en kan gebruikt worden voor

test en demonstratie doeleinden. De referentie implementatie is open source,

goed getest en beschikbaar als Docker image.

Quickstart

----------

1. Download en start de Objecttypen API:

   .. code:: bash

      wget https://raw.githubusercontent.com/maykinmedia/objecttypes-api/master/docker-compose.yml

      docker compose up -d --no-build

      docker compose exec -T web src/manage.py loaddata demodata

      docker compose exec web src/manage.py createsuperuser

2. In de browser, navigeer naar ``http://localhost:8000/`` om de admin en de

   API te benaderen.

Links

=====

* `Documentatie `_

* `Docker image `_

* `Issues `_

* `Code `_

* `Community `_

Licentie

========

Copyright © Maykin Media, 2020 - 2021

Licensed under the EUPL_

.. _`English version`: README.rst

.. _`Maykin Media B.V.`: https://www.maykinmedia.nl

.. _`Objecten API's`: https://github.com/maykinmedia/objects-api

.. _`EUPL`: LICENSE.md

.. |build-status| image:: https://github.com/maykinmedia/objecttypes-api/workflows/ci/badge.svg?branch=master

    :alt: Build status

    :target: https://github.com/maykinmedia/objecttypes-api/actions?query=workflow%3Aci

.. |docs| image:: https://readthedocs.org/projects/objects-and-objecttypes-api/badge/?version=latest

    :target: https://objects-and-objecttypes-api.readthedocs.io/

    :alt: Documentation Status

.. |coverage| image:: https://codecov.io/github/maykinmedia/objecttypes-api/branch/master/graphs/badge.svg?branch=master

    :alt: Coverage

    :target: https://codecov.io/gh/maykinmedia/objecttypes-api

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg

    :alt: Code style

    :target: https://github.com/psf/black

.. |docker| image:: https://images.microbadger.com/badges/image/maykinmedia/objecttypes-api.svg

    :alt: Docker image

    :target: https://hub.docker.com/r/maykinmedia/objecttypes-api

.. |python-versions| image:: https://img.shields.io/badge/python-3.7%2B-blue.svg

    :alt: Supported Python version

.. |lint-oas| image:: https://github.com/maykinmedia/objecttypes-api/workflows/lint-oas/badge.svg

    :alt: Lint OAS

    :target: https://github.com/maykinmedia/objecttypes-api/actions?query=workflow%3Alint-oas

.. |generate-sdks| image:: https://github.com/maykinmedia/objecttypes-api/workflows/generate-sdks/badge.svg

    :alt: Generate SDKs

    :target: https://github.com/maykinmedia/objecttypes-api/actions?query=workflow%3Agenerate-sdks

.. |generate-postman-collection| image:: https://github.com/maykinmedia/objecttypes-api/workflows/generate-postman-collection/badge.svg

    :alt: Generate Postman collection

    :target: https://github.com/maykinmedia/objecttypes-api/actions?query=workflow%3Agenerate-postman-collection