Client for rokka.io
Project description
rokka-client-codegen
This Python package for rokka.io was automatically generated by Swagger Codegen.
See the examples directory for some simple rokka specific examples.
A thin wrapper package for using this to make some things easier would be welcome. We're happy to help.
- API version: 1.1.0
- Package version: 0.2.0
Requirements.
Python 2.7 and 3.4+
Installation & Usage
pip install
If the python package is hosted on Github, you can install directly from Github
pip install rokka_client_codegen
Then import the package:
import rokka_client_codegen
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 rokka_client_codegen
Getting Started
Please follow the installation procedure and then see the examples directory.
Documentation for API Endpoints
All URIs are relative to https://api.rokka.io
Class | Method | HTTP request | Description |
---|---|---|---|
AdminApi | create_membership | PUT /organizations/{organization}/memberships/{userId} | Add a rokka user into an organization. |
AdminApi | create_membership_and_user | POST /organizations/{organization}/memberships | Creates a new user and api-key for the current user. |
AdminApi | create_organization | PUT /organizations/{organization} | Register a new Organization. |
AdminApi | create_organization_options | PUT /organizations/{organization}/options | Update options for an organization. |
AdminApi | create_user | POST /users | Register new user. |
AdminApi | delete_membership | DELETE /organizations/{organization}/memberships/{userId} | Remove a user from an organization. |
AdminApi | get_billing | GET /billing/{organization} | Returns monthly statistics for an organization grouped by its master and sub organisations. |
AdminApi | get_membership | GET /organizations/{organization}/memberships/{userId} | Get information about organization membership of a rokka user. |
AdminApi | get_organization | GET /organizations/{organization} | Get information about an organization. |
AdminApi | get_user | GET /user | Gets info for current user, currently just the user_id. |
AdminApi | list_membership | GET /organizations/{organization}/memberships | Get information about organization memberships of an organization. |
SourceimagesApi | copy_multiple_source_images | POST /sourceimages/{organization}/copy | Copy multiple source images to another org. |
SourceimagesApi | copy_source_image | POST /sourceimages/{organization}/{hash}/copy | Copy a single source image to another org. |
SourceimagesApi | create_source_image | POST /sourceimages/{organization} | Upload new source images. |
SourceimagesApi | create_source_image_meta_dynamic_with_name | PUT /sourceimages/{organization}/{hash}/meta/dynamic/{metaName} | Adds or updates a specific dynamic meta data for an image. |
SourceimagesApi | create_source_image_meta_user | PUT /sourceimages/{organization}/{hash}/meta/user | Replace the image meta data with new information. |
SourceimagesApi | create_source_image_meta_user_wth_name | PUT /sourceimages/{organization}/{hash}/meta/user/{metaName} | Adds or updates one user meta data field for an image. |
SourceimagesApi | delete_source_image | DELETE /sourceimages/{organization}/{hash} | Delete a single source image. |
SourceimagesApi | delete_source_image_cache | DELETE /sourceimages/{organization}/{hash}/cache | Delete the caches of a single source image. |
SourceimagesApi | delete_source_image_meta_dynamic_with_name | DELETE /sourceimages/{organization}/{hash}/meta/dynamic/{metaName} | Deletes a specific dynamic meta data. |
SourceimagesApi | delete_source_image_meta_user | DELETE /sourceimages/{organization}/{hash}/meta/user | Deletes all user meta data. |
SourceimagesApi | delete_source_image_meta_user_with_name | DELETE /sourceimages/{organization}/{hash}/meta/user/{metaName} | Deletes user meta data for a specified field. |
SourceimagesApi | download_source_image | GET /sourceimages/{organization}/{hash}/download | Download original source image binary. |
SourceimagesApi | get_source_image | GET /sourceimages/{organization}/{hash} | Get information about a source image. |
SourceimagesApi | get_source_image_meta_user | GET /sourceimages/{organization}/{hash}/meta/user | Get all user meta data. |
SourceimagesApi | get_source_image_meta_user_with_name | GET /sourceimages/{organization}/{hash}/meta/user/{metaName} | Get user meta for a specific field. |
SourceimagesApi | list_source_images | GET /sourceimages/{organization} | Get all images of an organization, with paging. |
SourceimagesApi | list_source_images_by_binary_hash | GET /sourceimages/{organization}/binaryhash/{binaryHash} | Get all images in this organization that match a binaryhash. |
SourceimagesApi | patch_source_image_meta_user | PATCH /sourceimages/{organization}/{hash}/meta/user | Update the specified meta data fields for an image. |
SourceimagesApi | restore_source_image | POST /sourceimages/{organization}/{hash}/restore | Restore source image including previously set metadata. |
StacksApi | create_stack | PUT /stacks/{organization}/{name} | Create a new stack. |
StacksApi | delete_stack | DELETE /stacks/{organization}/{name} | Delete a stack. |
StacksApi | get_stack | GET /stacks/{organization}/{name} | Get a single stack. |
StacksApi | list_operations | GET /operations | Listing all available operations that can be used in stacks. |
StacksApi | list_stack_options | GET /stackoptions | List all available options that can be set on stacks. |
StacksApi | list_stacks | GET /stacks/{organization} | Get all stacks of an organization. |
Documentation For Models
- InlineResponse200
- ListSourceImagesResponse
- ListStacksResponse
- ListUserMembershipsResponse
- Organization
- OrganizationDefinition
- OrganizationOptions
- Role
- Roles
- SourceImage
- Stack
- StackDefinition
- StackExpression
- StackExpressionOverrides
- StackOperation
- StackOperationDescription
- StackOperationDescriptionProperties
- StackOptions
- User
- UserDefinition
- UserMembership
Documentation For Authorization
ApiKeyAuth
- Type: API key
- API key parameter name: api-key
- Location: HTTP header
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for rokka_client_codegen-0.2.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0546b16e7afc69385ceedcb4affc77dfeb485740de3cb9d8371916f9f3a669a |
|
MD5 | d54dd3c29744c429012167a3552179ef |
|
BLAKE2b-256 | 37b66d9a824216775f6e6b46d6b70b5d474c0d4bc7012a5c04880b4d42f8fb06 |
Hashes for rokka_client_codegen-0.2.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 33e2e3c5fec594f7f4eb39b5306ac0b2067c31aafb1b5ea3c4de47da354b5dd1 |
|
MD5 | 61d97a0b46f94d1a778028a67841a7ed |
|
BLAKE2b-256 | 00d4afbe9910828b7b27451d303662fdc56a564db279f84925aec498d0ef04f8 |