Metadata-Version: 2.4
Name: flexo_sysml
Version: 0.2.0
Summary: Systems Modeling API and Services
Home-page: https://github.com/Open-MBEE/flexo-mms-sysmlv2
Author: OpenAPI Generator community
Author-email: OpenAPI Generator Community <team@openapitools.org>
License: Apache 2.0
Project-URL: Repository, https://github.com/Open-MBEE/flexo-mms-sysmlv2
Keywords: OpenAPI,OpenAPI-Generator,Systems Modeling API and Services
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2.11
Requires-Dist: typing-extensions>=4.7.1
Dynamic: author
Dynamic: home-page

# 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](https://openapi-generator.tech) 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:

```sh
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:
```python
import flexo_sysml
```

### Setuptools

Install via [Setuptools](http://pypi.python.org/pypi/setuptools).

```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)

Then import the package:
```python
import flexo_sysml
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*SysmlApi* | [**delete_branch_by_project_and_id**](docs/SysmlApi.md#delete_branch_by_project_and_id) | **DELETE** /projects/{projectId}/branches/{branchId} | Soft-delete branch by project and ID
*SysmlApi* | [**delete_project_by_id**](docs/SysmlApi.md#delete_project_by_id) | **DELETE** /projects/{projectId} | Soft-delete project by ID
*SysmlApi* | [**delete_query_by_project_and_id**](docs/SysmlApi.md#delete_query_by_project_and_id) | **DELETE** /projects/{projectId}/queries/{queryId} | Delete a saved query by ID
*SysmlApi* | [**delete_tag_by_project_and_id**](docs/SysmlApi.md#delete_tag_by_project_and_id) | **DELETE** /projects/{projectId}/tags/{tagId} | Soft-delete tag by project and ID
*SysmlApi* | [**diff**](docs/SysmlApi.md#diff) | **GET** /projects/{projectId}/commits/{compareCommitId}/diff | Diff between a base commit and a compare commit (stub)
*SysmlApi* | [**get_branch_by_project_and_id**](docs/SysmlApi.md#get_branch_by_project_and_id) | **GET** /projects/{projectId}/branches/{branchId} | Get branch by project and ID
*SysmlApi* | [**get_branches_by_project**](docs/SysmlApi.md#get_branches_by_project) | **GET** /projects/{projectId}/branches | Get branches for a project
*SysmlApi* | [**get_change_by_project_commit_id**](docs/SysmlApi.md#get_change_by_project_commit_id) | **GET** /projects/{projectId}/commits/{commitId}/changes/{changeId} | Get a specific change (DataVersion) by ID (stub)
*SysmlApi* | [**get_changes_by_project_commit**](docs/SysmlApi.md#get_changes_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/changes | Get changes (DataVersions) for a commit (stub)
*SysmlApi* | [**get_commit_by_project_and_id**](docs/SysmlApi.md#get_commit_by_project_and_id) | **GET** /projects/{projectId}/commits/{commitId} | Get commit by project and ID
*SysmlApi* | [**get_commits_by_project**](docs/SysmlApi.md#get_commits_by_project) | **GET** /projects/{projectId}/commits | Get commits for a project
*SysmlApi* | [**get_datatype_by_id**](docs/SysmlApi.md#get_datatype_by_id) | **GET** /meta/datatypes/{datatypeId} | Get a specific datatype by ID (stub)
*SysmlApi* | [**get_datatypes**](docs/SysmlApi.md#get_datatypes) | **GET** /meta/datatypes | Get available datatypes (stub)
*SysmlApi* | [**get_element_by_project_commit_id**](docs/SysmlApi.md#get_element_by_project_commit_id) | **GET** /projects/{projectId}/commits/{commitId}/elements/{elementId} | Get a specific element by ID at a commit
*SysmlApi* | [**get_elements_by_project_commit**](docs/SysmlApi.md#get_elements_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/elements | Get all elements at a specific commit
*SysmlApi* | [**get_project_by_id**](docs/SysmlApi.md#get_project_by_id) | **GET** /projects/{projectId} | Get project by ID
*SysmlApi* | [**get_project_usage_by_project_commit_element**](docs/SysmlApi.md#get_project_usage_by_project_commit_element) | **GET** /projects/{projectId}/commits/{commitId}/elements/{elementId}/projectUsage | Get ProjectUsage that originate the provided element
*SysmlApi* | [**get_projects**](docs/SysmlApi.md#get_projects) | **GET** /projects | Get all projects
*SysmlApi* | [**get_queries_by_project**](docs/SysmlApi.md#get_queries_by_project) | **GET** /projects/{projectId}/queries | Get saved queries for a project
*SysmlApi* | [**get_query_by_project_and_id**](docs/SysmlApi.md#get_query_by_project_and_id) | **GET** /projects/{projectId}/queries/{queryId} | Get a saved query by ID
*SysmlApi* | [**get_query_results_by_project_id_query**](docs/SysmlApi.md#get_query_results_by_project_id_query) | **GET** /projects/{projectId}/query-results | Execute an ad-hoc query via GET with body (stub)
*SysmlApi* | [**get_query_results_by_project_id_query_id**](docs/SysmlApi.md#get_query_results_by_project_id_query_id) | **GET** /projects/{projectId}/queries/{queryId}/results | Execute a saved query and return results
*SysmlApi* | [**get_query_results_by_project_id_query_post**](docs/SysmlApi.md#get_query_results_by_project_id_query_post) | **POST** /projects/{projectId}/query-results | Execute an ad-hoc query (via POST for client compatibility)
*SysmlApi* | [**get_relationships_by_project_commit_related_element**](docs/SysmlApi.md#get_relationships_by_project_commit_related_element) | **GET** /projects/{projectId}/commits/{commitId}/elements/{relatedElementId}/relationships | Get relationships for a related element
*SysmlApi* | [**get_roots_by_project_commit**](docs/SysmlApi.md#get_roots_by_project_commit) | **GET** /projects/{projectId}/commits/{commitId}/roots | Get root elements at a specific commit
*SysmlApi* | [**get_tag_by_project_and_id**](docs/SysmlApi.md#get_tag_by_project_and_id) | **GET** /projects/{projectId}/tags/{tagId} | Get tag by project and ID
*SysmlApi* | [**get_tags_by_project**](docs/SysmlApi.md#get_tags_by_project) | **GET** /projects/{projectId}/tags | Get tags for a project
*SysmlApi* | [**merge**](docs/SysmlApi.md#merge) | **POST** /projects/{projectId}/branches/{targetBranchId}/merge | Merge source commit(s) into a target branch (stub)
*SysmlApi* | [**post_branch_by_project**](docs/SysmlApi.md#post_branch_by_project) | **POST** /projects/{projectId}/branches | Create a branch for a project
*SysmlApi* | [**post_commit_by_project**](docs/SysmlApi.md#post_commit_by_project) | **POST** /projects/{projectId}/commits | Create a commit for a project
*SysmlApi* | [**post_project**](docs/SysmlApi.md#post_project) | **POST** /projects | Create a new project
*SysmlApi* | [**post_query_by_project**](docs/SysmlApi.md#post_query_by_project) | **POST** /projects/{projectId}/queries | Create a saved query for a project
*SysmlApi* | [**post_tag_by_project**](docs/SysmlApi.md#post_tag_by_project) | **POST** /projects/{projectId}/tags | Create a tag for a project
*SysmlApi* | [**put_project_by_id**](docs/SysmlApi.md#put_project_by_id) | **PUT** /projects/{projectId} | Update project by ID
*SysmlApi* | [**put_query_by_project_and_id**](docs/SysmlApi.md#put_query_by_project_and_id) | **PUT** /projects/{projectId}/queries/{queryId} | Update a saved query by ID


## Documentation For Models

 - [Branch](docs/Branch.md)
 - [BranchRequest](docs/BranchRequest.md)
 - [Commit](docs/Commit.md)
 - [CommitRequest](docs/CommitRequest.md)
 - [CompositeConstraint](docs/CompositeConstraint.md)
 - [Constraint](docs/Constraint.md)
 - [DataDifference](docs/DataDifference.md)
 - [DataIdentity](docs/DataIdentity.md)
 - [DataIdentityRequest](docs/DataIdentityRequest.md)
 - [DataVersion](docs/DataVersion.md)
 - [DataVersionRequest](docs/DataVersionRequest.md)
 - [Error](docs/Error.md)
 - [GetDatatypeById200Response](docs/GetDatatypeById200Response.md)
 - [GetDatatypes200Response](docs/GetDatatypes200Response.md)
 - [Identified](docs/Identified.md)
 - [PrimitiveConstraint](docs/PrimitiveConstraint.md)
 - [Project](docs/Project.md)
 - [ProjectRequest](docs/ProjectRequest.md)
 - [ProjectUsage](docs/ProjectUsage.md)
 - [Query](docs/Query.md)
 - [QueryRequest](docs/QueryRequest.md)
 - [Tag](docs/Tag.md)
 - [TagRequest](docs/TagRequest.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)


## Author




