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.

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

Bump VNG API common and rename BRC->besluiten API #79

Merged
merged 6 commits into from
Dec 23, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 20 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Besluiten API
=============

:Version: 1.0.1
:Source: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent
:Source: https://github.com/VNG-Realisatie/besluiten-api
:Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, BRC

Introductie
Expand All @@ -22,17 +22,17 @@ API specificaties
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================
Versie Release datum API specificatie Autorisaties Notificaties
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================
1.0.x n.v.t. `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/stable/1.0.x/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/stable/1.0.x/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/stable/1.0.x/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.1..stable/1.0.x?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
1.0.1 2019-12-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.1/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.1/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.1/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/compare/1.0.0..1.0.1?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
1.0.0 2019-11-18 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.0/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/1.0.0/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/gemma-besluitregistratiecomponent/1.0.0/src/openapi.yaml>`_
1.0.x n.v.t. `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/stable/1.0.x/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/besluiten-api/blob/stable/1.0.x/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/besluiten-api/blob/stable/1.0.x/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/stable/1.0.x/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/besluiten-api/compare/1.0.1..stable/1.0.x?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
1.0.1 2019-12-16 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/1.0.1/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/besluiten-api/blob/1.0.1/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/besluiten-api/blob/1.0.1/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/1.0.1/src/openapi.yaml>`_
(`verschillen <https://github.com/VNG-Realisatie/besluiten-api/compare/1.0.0..1.0.1?diff=split#diff-b9c28fec6c3f3fa5cff870d24601d6ab7027520f3b084cc767aefd258cb8c40a>`_)
1.0.0 2019-11-18 `ReDoc <https://redocly.github.io/redoc/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/1.0.0/src/openapi.yaml>`_, `Scopes <https://github.com/VNG-Realisatie/besluiten-api/blob/1.0.0/src/autorisaties.md>`_ `Berichtkenmerken <https://github.com/VNG-Realisatie/besluiten-api/blob/1.0.0/src/notificaties.md>`_
`Swagger <https://petstore.swagger.io/?url=https://raw.githubusercontent.com/VNG-Realisatie/besluiten-api/1.0.0/src/openapi.yaml>`_
========== ============== ==================================================================================================================================================================================================== ======================================================================================================================= =================================================================================================================================

Zie ook: `Alle versies en wijzigingen <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/blob/master/CHANGELOG.rst>`_
Zie ook: `Alle versies en wijzigingen <https://github.com/VNG-Realisatie/besluiten-api/blob/master/CHANGELOG.rst>`_

Ondersteuning
-------------
Expand Down Expand Up @@ -69,7 +69,7 @@ Links
* Bekijk de `demo omgeving`_ met de laatst gepubliceerde versie.
* Bekijk de `test omgeving <https://besluiten-api.test.vng.cloud/>`_ met de laatste ontwikkel versie.
* Rapporteer `issues <https://github.com/VNG-Realisatie/gemma-zaken/issues>`_ bij vragen, fouten of wensen.
* Bekijk de `code <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/>`_ van de referentie implementatie.
* Bekijk de `code <https://github.com/VNG-Realisatie/besluiten-api/>`_ van de referentie implementatie.

.. _`demo omgeving`: https://besluiten-api.vng.cloud/

Expand All @@ -86,12 +86,12 @@ Licensed under the EUPL_
:alt: Build status
:target: https://github.com/VNG-Realisatie/besluiten-api/actions?query=workflow%3Aci-build

.. |requirements| image:: https://requires.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/requirements.svg?branch=master
.. |requirements| image:: https://requires.io/github/VNG-Realisatie/besluiten-api/requirements.svg?branch=master
:alt: Requirements status

.. |coverage| image:: https://codecov.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/branch/master/graphs/badge.svg?branch=master
.. |coverage| image:: https://codecov.io/github/VNG-Realisatie/besluiten-api/branch/master/graphs/badge.svg?branch=master
:alt: Coverage
:target: https://codecov.io/gh/VNG-Realisatie/gemma-besluitregistratiecomponent
:target: https://codecov.io/gh/VNG-Realisatie/besluiten-api

.. |docker| image:: https://img.shields.io/badge/docker-latest-blue.svg
:alt: Docker image
Expand All @@ -104,14 +104,14 @@ Licensed under the EUPL_
.. |python-versions| image:: https://img.shields.io/badge/python-3.6%2B-blue.svg
:alt: Supported Python version

.. |lint-oas| image:: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/workflows/lint-oas/badge.svg
.. |lint-oas| image:: https://github.com/VNG-Realisatie/besluiten-api/workflows/lint-oas/badge.svg
:alt: Lint OAS
:target: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/actions?query=workflow%3Alint-oas
:target: https://github.com/VNG-Realisatie/besluiten-api/actions?query=workflow%3Alint-oas

.. |generate-sdks| image:: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/workflows/generate-sdks/badge.svg
.. |generate-sdks| image:: https://github.com/VNG-Realisatie/besluiten-api/workflows/generate-sdks/badge.svg
:alt: Generate SDKs
:target: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/actions?query=workflow%3Agenerate-sdks
:target: https://github.com/VNG-Realisatie/besluiten-api/actions?query=workflow%3Agenerate-sdks

.. |generate-postman-collection| image:: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/workflows/generate-postman-collection/badge.svg
.. |generate-postman-collection| image:: https://github.com/VNG-Realisatie/besluiten-api/workflows/generate-postman-collection/badge.svg
:alt: Generate Postman collection
:target: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/actions?query=workflow%3Agenerate-postman-collection
:target: https://github.com/VNG-Realisatie/besluiten-api/actions?query=workflow%3Agenerate-postman-collection
2 changes: 1 addition & 1 deletion docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
SPHINXPROJ = BesluitRegistratieComponent
SPHINXPROJ = Besluiten API
SOURCEDIR = .
BUILDDIR = _build

Expand Down
79 changes: 40 additions & 39 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,9 @@
# full list see the documentation:
# http://www.sphinx-doc.org/en/master/config

sys.path.insert(0, os.path.abspath('../src'))
sys.path.insert(0, os.path.abspath("../src"))

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'drc.conf.dev')
os.environ.setdefault("DJANGO_SETTINGS_MODULE", "drc.conf.dev")

django.setup()

Expand All @@ -28,12 +28,12 @@

# -- Project information -----------------------------------------------------

project = 'BesluitRegistratieComponent'
copyright = '2018, VNG Realisatie'
project = "Besluiten API"
copyright = "2018, VNG Realisatie"
author = brc.__author__

# The short X.Y version
version = '.'.join(map(str, brc.VERSION[0:2]))
version = ".".join(map(str, brc.VERSION[0:2]))
# The full version, including alpha/beta/rc tags
release = brc.__version__

Expand All @@ -47,23 +47,19 @@
# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
# ones.
extensions = [
'sphinx.ext.autodoc',
'sphinx.ext.intersphinx',
'sphinx.ext.coverage'
]
extensions = ["sphinx.ext.autodoc", "sphinx.ext.intersphinx", "sphinx.ext.coverage"]

# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
templates_path = ["_templates"]

# The suffix(es) of source filenames.
# You can specify multiple suffix as a list of string:
#
# source_suffix = ['.rst', '.md']
source_suffix = '.rst'
source_suffix = ".rst"

# The master toctree document.
master_doc = 'index'
master_doc = "index"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand All @@ -75,29 +71,29 @@
# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
# This pattern also affects html_static_path and html_extra_path .
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = 'sphinx'
pygments_style = "sphinx"


# -- Options for HTML output -------------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
#
html_theme = 'alabaster'
html_theme = "alabaster"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
#
html_theme_options = {
'github_user': 'VNG-Realisatie',
'github_banner': True,
'github_repo': 'gemma-besluitregistratiecomponent',
'travis_button': True,
'codecov_button': True,
"github_user": "VNG-Realisatie",
"github_banner": True,
"github_repo": "besluiten-api",
"travis_button": True,
"codecov_button": True,
# 'analytics_id': '',
}

Expand All @@ -115,11 +111,11 @@
# 'searchbox.html']``.
#
html_sidebars = {
'**': [
"**": [
# 'sidebar-intro.html',
'navigation.html',
'relations.html', # needs 'show_related': True theme option to display
'searchbox.html',
"navigation.html",
"relations.html", # needs 'show_related': True theme option to display
"searchbox.html",
]
}

Expand All @@ -129,7 +125,7 @@
# -- Options for HTMLHelp output ---------------------------------------------

# Output file base name for HTML help builder.
htmlhelp_basename = 'brcdoc'
htmlhelp_basename = "brcdoc"


# -- Options for LaTeX output ------------------------------------------------
Expand All @@ -138,15 +134,12 @@
# The paper size ('letterpaper' or 'a4paper').
#
# 'papersize': 'letterpaper',

# The font size ('10pt', '11pt' or '12pt').
#
# 'pointsize': '10pt',

# Additional stuff for the LaTeX preamble.
#
# 'preamble': '',

# Latex figure (float) alignment
#
# 'figure_align': 'htbp',
Expand All @@ -156,19 +149,21 @@
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
(master_doc, 'brc.tex', 'document\\_registratie\\_component Documentation',
'VNG Realisatie', 'manual'),
(
master_doc,
"brc.tex",
"document\\_registratie\\_component Documentation",
"VNG Realisatie",
"manual",
)
]


# -- Options for manual page output ------------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
(master_doc, 'brc', 'brc Documentation',
[author], 1)
]
man_pages = [(master_doc, "brc", "brc Documentation", [author], 1)]


# -- Options for Texinfo output ----------------------------------------------
Expand All @@ -177,13 +172,19 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
(master_doc, 'brc', 'brc Documentation',
author, 'brc', 'One line description of project.',
'Miscellaneous'),
(
master_doc,
"brc",
"brc Documentation",
author,
"brc",
"One line description of project.",
"Miscellaneous",
)
]


# -- Extension configuration -------------------------------------------------

# Example configuration for intersphinx: refer to the Python standard library.
intersphinx_mapping = {'https://docs.python.org/': None}
intersphinx_mapping = {"https://docs.python.org/": None}
4 changes: 2 additions & 2 deletions docs/contents/installation/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,13 +32,13 @@ You can retrieve the source code using the following command:

.. code-block:: bash

$ git clone git@github.com:VNG-realisatie/gemma-besluitregistratiecomponent.git brc
$ git clone git@github.com:VNG-realisatie/besluiten-api.git brc

**Note:** You can also use the HTTPS syntax:

.. code-block:: bash

$ git clone https://github.com/VNG-realisatie/gemma-besluitregistratiecomponent.git brc
$ git clone https://github.com/VNG-realisatie/besluiten-api.git brc

Setting up virtualenv
^^^^^^^^^^^^^^^^^^^^^^
Expand Down
4 changes: 2 additions & 2 deletions docs/contents/installation/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Docker basics

.. code-block:: bash

$ git clone https://github.com/VNG-realisatie/gemma-besluitregistratiecomponent.git brc
$ git clone https://github.com/VNG-realisatie/besluiten-api.git brc
Cloning into 'brc'...
...

Expand Down Expand Up @@ -104,6 +104,6 @@ You can override this location through the ``FIXTURES_DIR`` environment
variable. Only ``*.json`` files are considered.


.. _Github: https://github.com/VNG-realisatie/gemma-besluitregistratiecomponent
.. _Github: https://github.com/VNG-realisatie/besluiten-api
.. _Docker: https://docs.docker.com/install/
.. _Docker Compose: https://docs.docker.com/compose/install/
14 changes: 7 additions & 7 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ besluitregistratiecomponent
===========================

:Version: 1.0.1
:Source: https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent
:Source: https://github.com/VNG-Realisatie/besluiten-api
:Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, BRC
:PythonVersion: 3.6

Expand Down Expand Up @@ -45,16 +45,16 @@ Contents
References
============

* `Issues <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/issues>`_
* `Code <https://github.com/VNG-Realisatie/gemma-besluitregistratiecomponent/>`_
* `Issues <https://github.com/VNG-Realisatie/besluiten-api/issues>`_
* `Code <https://github.com/VNG-Realisatie/besluiten-api/>`_


.. |build-status| image:: http://jenkins.nlx.io/buildStatus/icon?job=gemma-besluitregistratiecomponent-stable
.. |build-status| image:: http://jenkins.nlx.io/buildStatus/icon?job=besluiten-api-stable
:alt: Build status
:target: http://jenkins.nlx.io/job/gemma-besluitregistratiecomponent-stable
:target: http://jenkins.nlx.io/job/besluiten-api-stable

.. |requirements| image:: https://requires.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/requirements.svg?branch=master
:target: https://requires.io/github/VNG-Realisatie/gemma-besluitregistratiecomponent/requirements/?branch=master
.. |requirements| image:: https://requires.io/github/VNG-Realisatie/besluiten-api/requirements.svg?branch=master
:target: https://requires.io/github/VNG-Realisatie/besluiten-api/requirements/?branch=master
:alt: Requirements status

.. _testomgeving: https://besluiten-api.vng.cloud/
12 changes: 8 additions & 4 deletions requirements/base.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@
# This file is autogenerated by pip-compile
# To update, run:
#
# pip-compile --no-index --output-file requirements/base.txt requirements/base.in
# pip-compile --no-index requirements/base.in
#
alabaster==0.7.12 # via sphinx
babel==2.6.0 # via sphinx
certifi==2018.8.24 # via requests
chardet==3.0.4 # via requests
click==6.7 # via pip-tools
click==7.1.2 # via pip-tools
coreapi==2.3.3 # via drf-yasg
coreschema==0.0.4 # via coreapi, drf-yasg
django-appconf==1.0.2 # via django-axes
Expand Down Expand Up @@ -39,7 +39,7 @@ markupsafe==1.1.1 # via jinja2
oyaml==0.7 # via vng-api-common
packaging==19.0 # via sphinx
pillow==5.2.0
pip-tools==4.2.0
pip-tools==5.4.0
psycopg2-binary==2.7.5
pygments==2.3.1 # via sphinx
pyjwt==1.6.4 # via gemma-zds-client, vng-api-common
Expand All @@ -61,4 +61,8 @@ sqlparse==0.3.0 # via django
unidecode==1.0.22 # via vng-api-common
uritemplate==3.0.0 # via coreapi, drf-yasg
urllib3==1.24.3 # via requests
vng-api-common==1.0.53
vng-api-common==1.0.56

# The following packages are considered to be unsafe in a requirements file:
# pip==20.3.3 # via pip-tools
# setuptools==51.1.0.post20201221 # via markdown, sphinx
Loading