flexo-sysml

REST/HTTP Platform Specific Model (PSM) for the Systems Modeling API and Services. Implemented by the Flexo MMS SysML v2 Microservice.

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

• API version: 0.2.0
• Package version: 0.2.0
• Generator version: 7.22.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

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 flexo_sysml

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 flexo_sysml

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import flexo_sysml
from flexo_sysml.rest import ApiException
from pprint import pprint

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

# 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): bearerAuth
configuration = flexo_sysml.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with flexo_sysml.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flexo_sysml.SysmlApi(api_client)
    project_id = 'project_id_example' # str | ID of the project
    branch_id = 'branch_id_example' # str | ID of the branch

    try:
        # Soft-delete branch by project and ID
        api_response = api_instance.delete_branch_by_project_and_id(project_id, branch_id)
        print("The response of SysmlApi->delete_branch_by_project_and_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling SysmlApi->delete_branch_by_project_and_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8080

Documentation For Models

• Branch
• BranchRequest
• Commit
• CommitRequest
• CompositeConstraint
• Constraint
• DataDifference
• DataIdentity
• DataIdentityRequest
• DataVersion
• DataVersionRequest
• Error
• GetDatatypeById200Response
• GetDatatypes200Response
• Identified
• PrimitiveConstraint
• Project
• ProjectRequest
• ProjectUsage
• Query
• QueryRequest
• Tag
• TagRequest

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author