dapla-toolbelt-metadata 0.2.1__py3-none-any.whl → 0.9.11__py3-none-any.whl

dapla_metadata/variable_definitions/_generated/vardef_client/docs/VariableDefinitionsApi.md

@@ -0,0 +1,304 @@
+# vardef_client.VariableDefinitionsApi
+
+All URIs are relative to *https://metadata.intern.test.ssb.no*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_public_variable_definition_by_id_0**](VariableDefinitionsApi.md#get_public_variable_definition_by_id_0) | **GET** /public/variable-definitions/{variable-definition-id} | Get one variable definition.
+[**get_variable_definition_by_id**](VariableDefinitionsApi.md#get_variable_definition_by_id) | **GET** /variable-definitions/{variable-definition-id} | Get one variable definition.
+[**list_public_variable_definitions_0**](VariableDefinitionsApi.md#list_public_variable_definitions_0) | **GET** /public/variable-definitions | List all variable definitions.
+[**list_variable_definitions**](VariableDefinitionsApi.md#list_variable_definitions) | **GET** /variable-definitions | List all variable definitions.
+
+
+# **get_public_variable_definition_by_id_0**
+> get_public_variable_definition_by_id_0(variable_definition_id, accept_language, date_of_validity=date_of_validity)
+
+Get one variable definition.
+
+Get one variable definition. This is rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.VariableDefinitionsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+    date_of_validity = '' # date | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # Get one variable definition.
+        api_instance.get_public_variable_definition_by_id_0(variable_definition_id, accept_language, date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling VariableDefinitionsApi->get_public_variable_definition_by_id_0: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+ **date_of_validity** | **date**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+**404** | No such variable definition found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_variable_definition_by_id**
+> get_variable_definition_by_id(variable_definition_id, date_of_validity=date_of_validity)
+
+Get one variable definition.
+
+Get one variable definition.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.VariableDefinitionsApi(api_client)
+    variable_definition_id = 'wypvb3wd' # str | Unique identifier for the variable definition.
+    date_of_validity = '' # date | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # Get one variable definition.
+        api_instance.get_variable_definition_by_id(variable_definition_id, date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling VariableDefinitionsApi->get_variable_definition_by_id: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **variable_definition_id** | **str**| Unique identifier for the variable definition. | 
+ **date_of_validity** | **date**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Ok |  -  |
+**404** | No such variable definition found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **list_public_variable_definitions_0**
+> list_public_variable_definitions_0(accept_language, date_of_validity=date_of_validity)
+
+List all variable definitions.
+
+List all variable definitions. These are rendered in the given language, with the default being Norwegian Bokmål.
+
+### Example
+
+
+```python
+import vardef_client
+from vardef_client.models.supported_languages import SupportedLanguages
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.VariableDefinitionsApi(api_client)
+    accept_language = vardef_client.SupportedLanguages() # SupportedLanguages | Render the variable definition in the given language.
+    date_of_validity = '' # str | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # List all variable definitions.
+        api_instance.list_public_variable_definitions_0(accept_language, date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling VariableDefinitionsApi->list_public_variable_definitions_0: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **accept_language** | [**SupportedLanguages**](.md)| Render the variable definition in the given language. | 
+ **date_of_validity** | **str**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **list_variable_definitions**
+> list_variable_definitions(date_of_validity=date_of_validity)
+
+List all variable definitions.
+
+List all variable definitions.
+
+### Example
+
+* Bearer (JWT) Authentication (Keycloak token):
+
+```python
+import vardef_client
+from vardef_client.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to https://metadata.intern.test.ssb.no
+# See configuration.py for a list of all supported configuration parameters.
+configuration = vardef_client.Configuration(
+    host = "https://metadata.intern.test.ssb.no"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+# Configure Bearer authorization (JWT): Keycloak token
+configuration = vardef_client.Configuration(
+    access_token = os.environ["BEARER_TOKEN"]
+)
+
+# Enter a context with an instance of the API client
+with vardef_client.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = vardef_client.VariableDefinitionsApi(api_client)
+    date_of_validity = '' # str | List only variable definitions which are valid on this date. (optional)
+
+    try:
+        # List all variable definitions.
+        api_instance.list_variable_definitions(date_of_validity=date_of_validity)
+    except Exception as e:
+        print("Exception when calling VariableDefinitionsApi->list_variable_definitions: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **date_of_validity** | **str**| List only variable definitions which are valid on this date. | [optional] 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[Keycloak token](../README.md#Keycloak token)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | OK response |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

dapla_metadata/variable_definitions/_generated/vardef_client/docs/VariableStatus.md

@@ -0,0 +1,17 @@
+# VariableStatus
+
+Life cycle status of a variable definition.
+
+## Enum
+
+* `DRAFT` (value: `'DRAFT'`)
+
+* `PUBLISHED_INTERNAL` (value: `'PUBLISHED_INTERNAL'`)
+
+* `PUBLISHED_EXTERNAL` (value: `'PUBLISHED_EXTERNAL'`)
+
+* `DEPRECATED` (value: `'DEPRECATED'`)
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

dapla_metadata/variable_definitions/_generated/vardef_client/exceptions.py

@@ -0,0 +1,193 @@
+"""Variable Definitions
+
+## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.   #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""
+
+from typing import Any
+
+from typing_extensions import Self
+
+
+class OpenApiException(Exception):
+    """The base exception class for all OpenAPIExceptions"""
+
+
+class ApiTypeError(OpenApiException, TypeError):
+    def __init__(
+        self, msg, path_to_item=None, valid_classes=None, key_type=None
+    ) -> None:
+        """Raises an exception for TypeErrors
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list): a list of keys an indices to get to the
+                                 current_item
+                                 None if unset
+            valid_classes (tuple): the primitive classes that current item
+                                   should be an instance of
+                                   None if unset
+            key_type (bool): False if our value is a value in a dict
+                             True if it is a key in a dict
+                             False if our item is an item in a list
+                             None if unset
+        """
+        self.path_to_item = path_to_item
+        self.valid_classes = valid_classes
+        self.key_type = key_type
+        full_msg = msg
+        if path_to_item:
+            full_msg = f"{msg} at {render_path(path_to_item)}"
+        super(ApiTypeError, self).__init__(full_msg)
+
+
+class ApiValueError(OpenApiException, ValueError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (list) the path to the exception in the
+                received_data dict. None if unset
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = f"{msg} at {render_path(path_to_item)}"
+        super(ApiValueError, self).__init__(full_msg)
+
+
+class ApiAttributeError(OpenApiException, AttributeError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """Raised when an attribute reference or assignment fails.
+
+        Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = f"{msg} at {render_path(path_to_item)}"
+        super(ApiAttributeError, self).__init__(full_msg)
+
+
+class ApiKeyError(OpenApiException, KeyError):
+    def __init__(self, msg, path_to_item=None) -> None:
+        """Args:
+            msg (str): the exception message
+
+        Keyword Args:
+            path_to_item (None/list) the path to the exception in the
+                received_data dict
+        """
+        self.path_to_item = path_to_item
+        full_msg = msg
+        if path_to_item:
+            full_msg = f"{msg} at {render_path(path_to_item)}"
+        super(ApiKeyError, self).__init__(full_msg)
+
+
+class ApiException(OpenApiException):
+    def __init__(
+        self,
+        status=None,
+        reason=None,
+        http_resp=None,
+        *,
+        body: str | None = None,
+        data: Any | None = None,
+    ) -> None:
+        self.status = status
+        self.reason = reason
+        self.body = body
+        self.data = data
+        self.headers = None
+
+        if http_resp:
+            if self.status is None:
+                self.status = http_resp.status
+            if self.reason is None:
+                self.reason = http_resp.reason
+            if self.body is None:
+                try:
+                    self.body = http_resp.data.decode("utf-8")
+                except Exception:
+                    pass
+            self.headers = http_resp.getheaders()
+
+    @classmethod
+    def from_response(
+        cls,
+        *,
+        http_resp,
+        body: str | None,
+        data: Any | None,
+    ) -> Self:
+        if http_resp.status == 400:
+            raise BadRequestException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 401:
+            raise UnauthorizedException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 403:
+            raise ForbiddenException(http_resp=http_resp, body=body, data=data)
+
+        if http_resp.status == 404:
+            raise NotFoundException(http_resp=http_resp, body=body, data=data)
+
+        if 500 <= http_resp.status <= 599:
+            raise ServiceException(http_resp=http_resp, body=body, data=data)
+        raise ApiException(http_resp=http_resp, body=body, data=data)
+
+    def __str__(self):
+        """Custom error messages for exception"""
+        error_message = f"({self.status})\nReason: {self.reason}\n"
+        if self.headers:
+            error_message += f"HTTP response headers: {self.headers}\n"
+
+        if self.data or self.body:
+            error_message += f"HTTP response body: {self.data or self.body}\n"
+
+        return error_message
+
+
+class BadRequestException(ApiException):
+    pass
+
+
+class NotFoundException(ApiException):
+    pass
+
+
+class UnauthorizedException(ApiException):
+    pass
+
+
+class ForbiddenException(ApiException):
+    pass
+
+
+class ServiceException(ApiException):
+    pass
+
+
+def render_path(path_to_item):
+    """Returns a string representation of a path"""
+    result = ""
+    for pth in path_to_item:
+        if isinstance(pth, int):
+            result += f"[{pth}]"
+        else:
+            result += f"['{pth}']"
+    return result

dapla_metadata/variable_definitions/_generated/vardef_client/models/__init__.py

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+# flake8: noqa
+"""
+Internal Variable Definitions Administration API
+
+ ## Introduction  Variable Definitions are centralized definitions of concrete variables which are typically present in multiple datasets. Variable Definitions support standardization of data and metadata and facilitate sharing and joining of data by clarifying when variables have an identical definition.  ## Maintenance of Variable Definitions This API allows for creation, maintenance and access of Variable Definitions.  ### Ownership Creation and maintenance of variables may only be performed by Statistics Norway employees representing a specific Dapla team, who are defined as the owners of a given Variable Definition. The team an owner represents must be specified when making a request through the `active_group` query parameter. All maintenance is to be performed by the owners, with no intervention from administrators.  ### Status All Variable Definitions have an associated status. The possible values for status are `DRAFT`, `PUBLISHED_INTERNAL` and `PUBLISHED_EXTERNAL`.  #### Draft When a Variable Definition is created it is assigned the status `DRAFT`. Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Mutable (it may be changed directly without need for versioning). - Not suitable to refer to from other systems.  This status may be changed to `PUBLISHED_INTERNAL` or `PUBLISHED_EXTERNAL` with a direct update.  #### Published Internal Under this status the Variable Definition is:  - Only visible to Statistics Norway employees. - Immutable (all changes are versioned). - Suitable to refer to in internal systems for statistics production. - Not suitable to refer to for external use (for example in Statistikkbanken).  This status may be changed to `PUBLISHED_EXTERNAL` by creating a Patch version.  #### Published External Under this status the Variable Definition is:  - Visible to the general public. - Immutable (all changes are versioned). - Suitable to refer to from any system.  This status may not be changed as it would break immutability. If a Variable Definition is no longer relevant then its period of validity should be ended by specifying a `valid_until` date in a Patch version.  ### Immutability Variable Definitions are immutable. This means that any changes must be performed in a strict versioning system. Consumers can avoid being exposed to breaking changes by specifying a `date_of_validity` when they request a Variable Definition.  #### Patches Patches are for changes which do not affect the fundamental meaning of the Variable Definition.  #### Validity Periods Validity Periods are versions with a period defined by a `valid_from` date and optionally a `valid_until` date. If the fundamental meaning of a Variable Definition is to be changed, it should be done by creating a new Validity Period.
+
+The version of the OpenAPI document: 0.1
+Contact: metadata@ssb.no
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+# import models into model package
+from ..models.complete_response import CompleteResponse
+from ..models.contact import Contact
+from ..models.draft import Draft
+from ..models.get_vardok_vardef_mapping_by_id200_response import (
+    GetVardokVardefMappingById200Response,
+)
+from ..models.language_string_type import LanguageStringType
+from ..models.owner import Owner
+from ..models.patch import Patch
+from ..models.problem import Problem
+from ..models.update_draft import UpdateDraft
+from ..models.validity_period import ValidityPeriod
+from ..models.vardok_id_response import VardokIdResponse
+from ..models.vardok_vardef_id_pair_response import VardokVardefIdPairResponse
+from ..models.variable_status import VariableStatus