Metadata-Version: 2.4
Name: flexo_layer1
Version: 0.3.0
Summary: Flexo MMS Layer 1 Service API
Home-page: https://github.com/Open-MBEE/flexo-mms-layer1-service
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-layer1-service
Keywords: OpenAPI,OpenAPI-Generator,Flexo MMS Layer 1 Service API
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-layer1
RESTful API for the Flexo MMS Layer 1 Service. Manages Orgs, Repos, branches, locks, commits, diffs, scratches, collections, artifacts, groups, and policies. Backed by a SPARQL 1.1 quad-store. Uses Linked Data Platform (LDP) and Graph Store Protocol (GSP) conventions.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.3.0
- Package version: 0.3.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_layer1
```

### 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_layer1
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

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

```python

import flexo_layer1
from flexo_layer1.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_layer1.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_layer1.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
with flexo_layer1.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = flexo_layer1.FlexoLayer1Api(api_client)
    org_id = 'my-org' # str | 
    repo_id = 'my-repo' # str | 
    branch_id = 'main' # str | 
    body = prefix rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
insert data {
  <urn:some:uri> rdf:type <urn:my:type> .
}
 # str | SPARQL Update request.

    try:
        # Commit a SPARQL Update to a branch's model
        api_response = api_instance.commit_model(org_id, repo_id, branch_id, body)
        print("The response of FlexoLayer1Api->commit_model:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling FlexoLayer1Api->commit_model: %s\n" % e)

```

## Documentation for API Endpoints

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

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*FlexoLayer1Api* | [**commit_model**](docs/FlexoLayer1Api.md#commit_model) | **POST** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/update | Commit a SPARQL Update to a branch&#39;s model
*FlexoLayer1Api* | [**create_artifact**](docs/FlexoLayer1Api.md#create_artifact) | **POST** /orgs/{orgId}/repos/{repoId}/artifacts | Upload a new artifact
*FlexoLayer1Api* | [**create_branch**](docs/FlexoLayer1Api.md#create_branch) | **PUT** /orgs/{orgId}/repos/{repoId}/branches/{branchId} | Create a branch
*FlexoLayer1Api* | [**create_branch_via_post**](docs/FlexoLayer1Api.md#create_branch_via_post) | **POST** /orgs/{orgId}/repos/{repoId}/branches | Create a new branch
*FlexoLayer1Api* | [**create_collection**](docs/FlexoLayer1Api.md#create_collection) | **POST** /orgs/{orgId}/collections | Create a new collection
*FlexoLayer1Api* | [**create_group**](docs/FlexoLayer1Api.md#create_group) | **POST** /groups | Create a new group
*FlexoLayer1Api* | [**create_lock**](docs/FlexoLayer1Api.md#create_lock) | **PUT** /orgs/{orgId}/repos/{repoId}/locks/{lockId} | Create a lock
*FlexoLayer1Api* | [**create_lock_via_post**](docs/FlexoLayer1Api.md#create_lock_via_post) | **POST** /orgs/{orgId}/repos/{repoId}/locks | Create a new lock
*FlexoLayer1Api* | [**create_or_replace_collection**](docs/FlexoLayer1Api.md#create_or_replace_collection) | **PUT** /orgs/{orgId}/collections/{collectionId} | Create or replace a collection
*FlexoLayer1Api* | [**create_or_replace_group**](docs/FlexoLayer1Api.md#create_or_replace_group) | **PUT** /groups/{groupId} | Create or replace a group
*FlexoLayer1Api* | [**create_or_replace_org**](docs/FlexoLayer1Api.md#create_or_replace_org) | **PUT** /orgs/{orgId} | Create or replace an organization
*FlexoLayer1Api* | [**create_or_replace_policy**](docs/FlexoLayer1Api.md#create_or_replace_policy) | **PUT** /policies/{policyId} | Create or replace a policy
*FlexoLayer1Api* | [**create_or_replace_repo**](docs/FlexoLayer1Api.md#create_or_replace_repo) | **PUT** /orgs/{orgId}/repos/{repoId} | Create or replace a repository
*FlexoLayer1Api* | [**create_or_replace_scratch**](docs/FlexoLayer1Api.md#create_or_replace_scratch) | **PUT** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId} | Create or replace a scratch
*FlexoLayer1Api* | [**create_org**](docs/FlexoLayer1Api.md#create_org) | **POST** /orgs | Create a new organization
*FlexoLayer1Api* | [**create_policy**](docs/FlexoLayer1Api.md#create_policy) | **POST** /policies | Create a new policy
*FlexoLayer1Api* | [**create_repo**](docs/FlexoLayer1Api.md#create_repo) | **POST** /orgs/{orgId}/repos | Create a new repository
*FlexoLayer1Api* | [**create_scratch**](docs/FlexoLayer1Api.md#create_scratch) | **POST** /orgs/{orgId}/repos/{repoId}/scratches | Create a new scratch
*FlexoLayer1Api* | [**delete_branch**](docs/FlexoLayer1Api.md#delete_branch) | **DELETE** /orgs/{orgId}/repos/{repoId}/branches/{branchId} | Delete a branch (not implemented)
*FlexoLayer1Api* | [**delete_lock**](docs/FlexoLayer1Api.md#delete_lock) | **DELETE** /orgs/{orgId}/repos/{repoId}/locks/{lockId} | Delete a lock
*FlexoLayer1Api* | [**get_artifact**](docs/FlexoLayer1Api.md#get_artifact) | **GET** /orgs/{orgId}/repos/{repoId}/artifacts/{artifactId} | Read an artifact
*FlexoLayer1Api* | [**get_artifacts**](docs/FlexoLayer1Api.md#get_artifacts) | **GET** /orgs/{orgId}/repos/{repoId}/artifacts | List all artifacts
*FlexoLayer1Api* | [**get_branch**](docs/FlexoLayer1Api.md#get_branch) | **GET** /orgs/{orgId}/repos/{repoId}/branches/{branchId} | Read a branch
*FlexoLayer1Api* | [**get_branch_graph**](docs/FlexoLayer1Api.md#get_branch_graph) | **GET** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/graph | Read a branch&#39;s model graph
*FlexoLayer1Api* | [**get_branches**](docs/FlexoLayer1Api.md#get_branches) | **GET** /orgs/{orgId}/repos/{repoId}/branches | List all branches
*FlexoLayer1Api* | [**get_collection**](docs/FlexoLayer1Api.md#get_collection) | **GET** /orgs/{orgId}/collections/{collectionId} | Read a collection
*FlexoLayer1Api* | [**get_collection_graph**](docs/FlexoLayer1Api.md#get_collection_graph) | **GET** /orgs/{orgId}/collections/{collectionId}/graph | Read the collection&#39;s union graph
*FlexoLayer1Api* | [**get_collections**](docs/FlexoLayer1Api.md#get_collections) | **GET** /orgs/{orgId}/collections | List all collections
*FlexoLayer1Api* | [**get_commit**](docs/FlexoLayer1Api.md#get_commit) | **GET** /orgs/{orgId}/repos/{repoId}/commits/{commitId} | Read a commit
*FlexoLayer1Api* | [**get_commits**](docs/FlexoLayer1Api.md#get_commits) | **GET** /orgs/{orgId}/repos/{repoId}/commits | List all commits
*FlexoLayer1Api* | [**get_group**](docs/FlexoLayer1Api.md#get_group) | **GET** /groups/{groupId} | Read a group
*FlexoLayer1Api* | [**get_groups**](docs/FlexoLayer1Api.md#get_groups) | **GET** /groups | List all groups
*FlexoLayer1Api* | [**get_lock**](docs/FlexoLayer1Api.md#get_lock) | **GET** /orgs/{orgId}/repos/{repoId}/locks/{lockId} | Read a lock
*FlexoLayer1Api* | [**get_lock_graph**](docs/FlexoLayer1Api.md#get_lock_graph) | **GET** /orgs/{orgId}/repos/{repoId}/locks/{lockId}/graph | Read a lock&#39;s model graph
*FlexoLayer1Api* | [**get_locks**](docs/FlexoLayer1Api.md#get_locks) | **GET** /orgs/{orgId}/repos/{repoId}/locks | List all locks
*FlexoLayer1Api* | [**get_org**](docs/FlexoLayer1Api.md#get_org) | **GET** /orgs/{orgId} | Read an organization
*FlexoLayer1Api* | [**get_orgs**](docs/FlexoLayer1Api.md#get_orgs) | **GET** /orgs | List all Orgs
*FlexoLayer1Api* | [**get_repo**](docs/FlexoLayer1Api.md#get_repo) | **GET** /orgs/{orgId}/repos/{repoId} | Read a repository
*FlexoLayer1Api* | [**get_repo_graph**](docs/FlexoLayer1Api.md#get_repo_graph) | **GET** /orgs/{orgId}/repos/{repoId}/graph | Read repository metadata graph
*FlexoLayer1Api* | [**get_repos**](docs/FlexoLayer1Api.md#get_repos) | **GET** /orgs/{orgId}/repos | List all Repos
*FlexoLayer1Api* | [**get_scratch**](docs/FlexoLayer1Api.md#get_scratch) | **GET** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId} | Read a scratch
*FlexoLayer1Api* | [**get_scratch_graph**](docs/FlexoLayer1Api.md#get_scratch_graph) | **GET** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/graph | Read a scratch graph
*FlexoLayer1Api* | [**get_scratches**](docs/FlexoLayer1Api.md#get_scratches) | **GET** /orgs/{orgId}/repos/{repoId}/scratches | List all scratches
*FlexoLayer1Api* | [**head_artifact**](docs/FlexoLayer1Api.md#head_artifact) | **HEAD** /orgs/{orgId}/repos/{repoId}/artifacts/{artifactId} | State of an artifact
*FlexoLayer1Api* | [**head_artifacts**](docs/FlexoLayer1Api.md#head_artifacts) | **HEAD** /orgs/{orgId}/repos/{repoId}/artifacts | State of all artifacts
*FlexoLayer1Api* | [**head_branch**](docs/FlexoLayer1Api.md#head_branch) | **HEAD** /orgs/{orgId}/repos/{repoId}/branches/{branchId} | State of a branch
*FlexoLayer1Api* | [**head_branch_graph**](docs/FlexoLayer1Api.md#head_branch_graph) | **HEAD** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/graph | State of a branch&#39;s model graph
*FlexoLayer1Api* | [**head_branches**](docs/FlexoLayer1Api.md#head_branches) | **HEAD** /orgs/{orgId}/repos/{repoId}/branches | State of all branches
*FlexoLayer1Api* | [**head_collection**](docs/FlexoLayer1Api.md#head_collection) | **HEAD** /orgs/{orgId}/collections/{collectionId} | State of a collection
*FlexoLayer1Api* | [**head_collection_graph**](docs/FlexoLayer1Api.md#head_collection_graph) | **HEAD** /orgs/{orgId}/collections/{collectionId}/graph | State of the collection&#39;s union graph
*FlexoLayer1Api* | [**head_collections**](docs/FlexoLayer1Api.md#head_collections) | **HEAD** /orgs/{orgId}/collections | State of all collections
*FlexoLayer1Api* | [**head_commit**](docs/FlexoLayer1Api.md#head_commit) | **HEAD** /orgs/{orgId}/repos/{repoId}/commits/{commitId} | State of a commit
*FlexoLayer1Api* | [**head_commits**](docs/FlexoLayer1Api.md#head_commits) | **HEAD** /orgs/{orgId}/repos/{repoId}/commits | State of all commits
*FlexoLayer1Api* | [**head_group**](docs/FlexoLayer1Api.md#head_group) | **HEAD** /groups/{groupId} | State of a group
*FlexoLayer1Api* | [**head_groups**](docs/FlexoLayer1Api.md#head_groups) | **HEAD** /groups | State of all groups
*FlexoLayer1Api* | [**head_lock**](docs/FlexoLayer1Api.md#head_lock) | **HEAD** /orgs/{orgId}/repos/{repoId}/locks/{lockId} | State of a lock
*FlexoLayer1Api* | [**head_lock_graph**](docs/FlexoLayer1Api.md#head_lock_graph) | **HEAD** /orgs/{orgId}/repos/{repoId}/locks/{lockId}/graph | State of a lock&#39;s model graph
*FlexoLayer1Api* | [**head_locks**](docs/FlexoLayer1Api.md#head_locks) | **HEAD** /orgs/{orgId}/repos/{repoId}/locks | State of all locks
*FlexoLayer1Api* | [**head_org**](docs/FlexoLayer1Api.md#head_org) | **HEAD** /orgs/{orgId} | State of an organization
*FlexoLayer1Api* | [**head_orgs**](docs/FlexoLayer1Api.md#head_orgs) | **HEAD** /orgs | State of all Orgs
*FlexoLayer1Api* | [**head_repo**](docs/FlexoLayer1Api.md#head_repo) | **HEAD** /orgs/{orgId}/repos/{repoId} | State of a repository
*FlexoLayer1Api* | [**head_repo_graph**](docs/FlexoLayer1Api.md#head_repo_graph) | **HEAD** /orgs/{orgId}/repos/{repoId}/graph | State of repository metadata graph
*FlexoLayer1Api* | [**head_repos**](docs/FlexoLayer1Api.md#head_repos) | **HEAD** /orgs/{orgId}/repos | State of all Repos
*FlexoLayer1Api* | [**head_scratch**](docs/FlexoLayer1Api.md#head_scratch) | **HEAD** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId} | State of a scratch
*FlexoLayer1Api* | [**head_scratch_graph**](docs/FlexoLayer1Api.md#head_scratch_graph) | **HEAD** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/graph | State of a scratch graph
*FlexoLayer1Api* | [**head_scratches**](docs/FlexoLayer1Api.md#head_scratches) | **HEAD** /orgs/{orgId}/repos/{repoId}/scratches | State of all scratches
*FlexoLayer1Api* | [**load_branch_graph**](docs/FlexoLayer1Api.md#load_branch_graph) | **PUT** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/graph | Load (overwrite) a branch&#39;s model graph
*FlexoLayer1Api* | [**load_scratch_graph**](docs/FlexoLayer1Api.md#load_scratch_graph) | **PUT** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/graph | Load (overwrite) a scratch graph
*FlexoLayer1Api* | [**query_collection_inspect_post**](docs/FlexoLayer1Api.md#query_collection_inspect_post) | **POST** /orgs/{orgId}/collections/{collectionId}/query/inspect | SPARQL query against a collection with inspection (via body)
*FlexoLayer1Api* | [**query_collection_post**](docs/FlexoLayer1Api.md#query_collection_post) | **POST** /orgs/{orgId}/collections/{collectionId}/query | SPARQL query against a collection (via body)
*FlexoLayer1Api* | [**query_lock_inspect_post**](docs/FlexoLayer1Api.md#query_lock_inspect_post) | **POST** /orgs/{orgId}/repos/{repoId}/locks/{lockId}/query/inspect | SPARQL query against a lock with inspection (via body)
*FlexoLayer1Api* | [**query_lock_post**](docs/FlexoLayer1Api.md#query_lock_post) | **POST** /orgs/{orgId}/repos/{repoId}/locks/{lockId}/query | SPARQL query against a lock (via body)
*FlexoLayer1Api* | [**query_model_inspect_post**](docs/FlexoLayer1Api.md#query_model_inspect_post) | **POST** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/query/inspect | SPARQL query against a branch&#39;s model with inspection (via body)
*FlexoLayer1Api* | [**query_model_post**](docs/FlexoLayer1Api.md#query_model_post) | **POST** /orgs/{orgId}/repos/{repoId}/branches/{branchId}/query | SPARQL query against a branch&#39;s model (via body)
*FlexoLayer1Api* | [**query_repo_inspect_post**](docs/FlexoLayer1Api.md#query_repo_inspect_post) | **POST** /orgs/{orgId}/repos/{repoId}/query/inspect | SPARQL query against a repository with inspection (via body)
*FlexoLayer1Api* | [**query_repo_post**](docs/FlexoLayer1Api.md#query_repo_post) | **POST** /orgs/{orgId}/repos/{repoId}/query | SPARQL query against a repository (via body)
*FlexoLayer1Api* | [**query_scratch_inspect_post**](docs/FlexoLayer1Api.md#query_scratch_inspect_post) | **POST** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/query/inspect | SPARQL query against a scratch with inspection (via body)
*FlexoLayer1Api* | [**query_scratch_post**](docs/FlexoLayer1Api.md#query_scratch_post) | **POST** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/query | SPARQL query against a scratch (via body)
*FlexoLayer1Api* | [**squash_commits**](docs/FlexoLayer1Api.md#squash_commits) | **POST** /orgs/{orgId}/repos/{repoId}/squash | Squash a linear commit range between two locks
*FlexoLayer1Api* | [**update_branch**](docs/FlexoLayer1Api.md#update_branch) | **PATCH** /orgs/{orgId}/repos/{repoId}/branches/{branchId} | Update branch metadata
*FlexoLayer1Api* | [**update_commit**](docs/FlexoLayer1Api.md#update_commit) | **PATCH** /orgs/{orgId}/repos/{repoId}/commits/{commitId} | Update commit metadata
*FlexoLayer1Api* | [**update_lock**](docs/FlexoLayer1Api.md#update_lock) | **PATCH** /orgs/{orgId}/repos/{repoId}/locks/{lockId} | Update lock metadata
*FlexoLayer1Api* | [**update_org**](docs/FlexoLayer1Api.md#update_org) | **PATCH** /orgs/{orgId} | Update an organization
*FlexoLayer1Api* | [**update_repo**](docs/FlexoLayer1Api.md#update_repo) | **PATCH** /orgs/{orgId}/repos/{repoId} | Update a repository
*FlexoLayer1Api* | [**update_scratch**](docs/FlexoLayer1Api.md#update_scratch) | **POST** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId}/update | Apply a SPARQL Update to a scratch graph
*FlexoLayer1Api* | [**update_scratch_metadata**](docs/FlexoLayer1Api.md#update_scratch_metadata) | **PATCH** /orgs/{orgId}/repos/{repoId}/scratches/{scratchId} | Update scratch metadata


## Documentation For Models



<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




