Wardley_API_Python_SDK

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

• API version: 2.8.3
• Package version: 0.8.1
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >=3.6

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 WardleyCrewAPI

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 WardleyCrewAPI

Getting Started

Please follow the installation procedure and then run the following:

import time
import WardleyCrewAPI
from pprint import pprint
from WardleyCrewAPI.api import conversions_api
from WardleyCrewAPI.model.http_validation_error import HTTPValidationError
from WardleyCrewAPI.model.map_id_request import MapIdRequest
from WardleyCrewAPI.model.owm_text_request import OwmTextRequest
# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = WardleyCrewAPI.Configuration(
    host = "http://localhost"
)



# Enter a context with an instance of the API client
with WardleyCrewAPI.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = conversions_api.ConversionsApi(api_client)
    map_id_request = MapIdRequest(
        map_id="map_id_example",
    ) # MapIdRequest | 

    try:
        # Convert Id 2 Png
        api_response = api_instance.convert_id2_png_v2_convertid2png_post(map_id_request)
        pprint(api_response)
    except WardleyCrewAPI.ApiException as e:
        print("Exception when calling ConversionsApi->convert_id2_png_v2_convertid2png_post: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
ConversionsApi	convert_id2_png_v2_convertid2png_post	POST /v2/convertid2png	Convert Id 2 Png
ConversionsApi	convert_owm2_json_v2_convertowm2json_post	POST /v2/convertowm2json	Convert Owm 2 Json
ConversionsApi	convert_owm2_png_v2_convertowm2png_post	POST /v2/convertowm2png	Convert Owm 2 Png
ConversionsApi	convert_owm2_svg_v2_convertowm2svg_post	POST /v2/convertowm2svg	Convert Owm 2 Svg
ConversionsApi	convert_owm2_toml_v2_convertowm2toml_post	POST /v2/convertowm2toml	Convert Owm 2 Toml
ConversionsApi	convert_owm2_yaml_v2_convertowm2yaml_post	POST /v2/convertowm2yaml	Convert Owm 2 Yaml
OpenWardleyMapsApi	generate_map_from_id_v2_generate_mapfromid_post	POST /v2/generate-mapfromid	Generate Map From Id
OpenWardleyMapsApi	generate_map_from_text_v2_generate_mapfromtext_post	POST /v2/generate-mapfromtext	Generate Map From Text
OpenWardleyMapsApi	generate_svg_map_v2_generate_svgmap_post	POST /v2/generate-svgmap	Generate Svg Map
OpenWardleyMapsApi	get_owm_anchors_v2_get_owm_anchors_post	POST /v2/get-owm-anchors	Get Owm Anchors
OpenWardleyMapsApi	get_owm_annotations_v2_get_owm_annotations_post	POST /v2/get-owm-annotations	Get Owm Annotations
OpenWardleyMapsApi	get_owm_component_v2_get_owm_component_post	POST /v2/get-owm-component	Get Owm Component
OpenWardleyMapsApi	get_owm_components_v2_get_owm_components_post	POST /v2/get-owm-components	Get Owm Components
OpenWardleyMapsApi	get_owm_map_text_v2_get_owm_text_post	POST /v2/get-owm-text	Get Owm Map Text
OpenWardleyMapsApi	get_owm_notes_v2_get_owm_notes_post	POST /v2/get-owm-notes	Get Owm Notes
OpenWardleyMapsApi	get_owm_pipelines_v2_get_owm_pipelines_post	POST /v2/get-owm-pipelines	Get Owm Pipelines
OpenWardleyMapsApi	get_owm_warnings_v2_get_owm_warnings_post	POST /v2/get-owm-warnings	Get Owm Warnings
OpenWardleyMapsApi	search_owm_components_v2_search_owm_components_post	POST /v2/search-owm-components	Search Owm Components
ToolsApi	get_github_map_v2_get_github_map_get	GET /v2/get-github-map	Get Github Map
ToolsApi	list_github_maps_v2_list_github_maps_get	GET /v2/list-github-maps	List Github Maps
ToolsApi	open_map_v2_openmap_get	GET /v2/openmap	Open Map
ToolsApi	privacy_statement_v2_privacy_get	GET /v2/privacy	Privacy Statement
WardleyMapsOnlineApi	fetch_wardley_data_v2_maps_fetch_get	GET /v2/maps/fetch	Fetch Wardley Data
WardleyMapsOnlineApi	get_image_v2_image_filename_get	GET /v2/image/{filename}	Get Image
WardleyMapsOnlineApi	save_wardley_map_v2_maps_save_post	POST /v2/maps/save	Save Wardley Map

Documentation For Models

• ComponentRequest
• HTTPValidationError
• MapIdRequest
• MapTextAndWarnings
• OwmTextRequest
• SearchComponentRequest
• TextRequest
• ValidationError

Documentation For Authorization

All endpoints do not require authorization.

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in WardleyCrewAPI.apis and WardleyCrewAPI.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from WardleyCrewAPI.api.default_api import DefaultApi
• from WardleyCrewAPI.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import WardleyCrewAPI
from WardleyCrewAPI.apis import *
from WardleyCrewAPI.models import *