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 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:

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_layer1

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_layer1

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author