Announcement_Service/README.md

2.7 KiB

openapi-client

Announcing patchnotes for KanzleiApp

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.7.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import openapi_client

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import openapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:


import openapi_client
from openapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://https
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_client.Configuration(
    host = "http://https"
)



# Enter a context with an instance of the API client
with openapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = openapi_client.DefaultApi(api_client)

    try:
        api_response = api_instance.get_patchnotes()
        print("The response of DefaultApi->get_patchnotes:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling DefaultApi->get_patchnotes: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://https

Class Method HTTP request Description
DefaultApi get_patchnotes GET /patchnotes
DefaultApi patch_note_delete DELETE /patchnotes/{patchID}
DefaultApi patch_note_update PUT /patchnotes/{patchID}
DefaultApi post_patchnotes POST /patchnotes

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Author