rokka_client_codegen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35e4a03f2718d2e7f9bca0bdafed6672241498cde8ba4a51c821ea362cec2f0c
+  data.tar.gz: ebf3bd621b89a73c648778d18837a3462ff12c75042df4fc6671fe0aefc078b2
+SHA512:
+  metadata.gz: 9b7760638d0fd1e9fbb189213cb2b0c60c62691628a96e52d35cf7a95d5813b6f6eae9ad6181591fbe599b7d4e5850cada9ef980670f91e8cfab4229e9915a0e
+  data.tar.gz: 4fefdcea096ba4877d4110627f05fb1d2dda7143cb1b5a6b407f874ecf989a72f26f073db83d46bc1ca14e4cbf7b4337e57f6db4587c875d01220038977c139b

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Christian Stocker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# rokka_client_codegen
+
+This Ruby gem for rokka.io was automatically generated by [Swagger Codegen](https://github.com/swagger-api/swagger-codegen).
+
+See the [examples](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](https://rokka.io/en/contact/).
+
+The gem is currently nowhere published, you have to build it yourself (see below). But if needed, we will publish it.
+
+- API version: 1.0.0
+- Package version: 0.0.1
+- Build package: io.swagger.codegen.languages.RubyClientCodegen
+
+## Installation
+
+### Build a gem
+
+To build the Ruby code into a gem:
+
+```shell
+gem build rokka_client_codegen.gemspec
+```
+
+Then either install the gem locally:
+
+```shell
+gem install ./rokka_client_codegen-0.0.1.gem
+```
+(for development, run `gem install --dev ./rokka_client_codegen-0.0.1.gem` to install the development dependencies)
+
+or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
+
+Finally add this to the Gemfile:
+
+    gem 'rokka_client_codegen', '~> 0.0.1'
+
+### Install from Git
+
+If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'rokka_client_codegen', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
+
+### Include the Ruby code directly
+
+Include the Ruby code directly using `-I` as follows:
+
+```shell
+ruby -Ilib script.rb
+```
+
+## Getting Started
+
+Please follow the [installation procedure](#installation--usage) and then see the [examples](examples/)  directory.
+
+## Documentation for API Endpoints
+
+All URIs are relative to *https://api.rokka.io*
+
+Class | Method | HTTP request | Description
+------------ | ------------- | ------------- | -------------
+*RokkaClientCodegen::AdminApi* | [**create_membership**](docs/AdminApi.md#create_membership) | **PUT** /organizations/{organization}/memberships/{email} | Add a rokka user into an organization.
+*RokkaClientCodegen::AdminApi* | [**create_organization**](docs/AdminApi.md#create_organization) | **PUT** /organizations/{organization} | Register a new Organization.
+*RokkaClientCodegen::AdminApi* | [**create_organization_options**](docs/AdminApi.md#create_organization_options) | **PUT** /organizations/{organization}/options | Update options for an organization.
+*RokkaClientCodegen::AdminApi* | [**create_user**](docs/AdminApi.md#create_user) | **POST** /users | Register new user.
+*RokkaClientCodegen::AdminApi* | [**delete_membership**](docs/AdminApi.md#delete_membership) | **DELETE** /organizations/{organization}/memberships/{email} | Remove a user from an organization.
+*RokkaClientCodegen::AdminApi* | [**get_membership**](docs/AdminApi.md#get_membership) | **GET** /organizations/{organization}/memberships/{email} | Get information about organization membership of a rokka user.
+*RokkaClientCodegen::AdminApi* | [**get_organization**](docs/AdminApi.md#get_organization) | **GET** /organizations/{organization} | Get information about an organization.
+*RokkaClientCodegen::SourceimagesApi* | [**copy_source_image**](docs/SourceimagesApi.md#copy_source_image) | **POST** /sourceimages/{organization}/{hash}/copy | Copy a single source image to another org.
+*RokkaClientCodegen::SourceimagesApi* | [**create_source_image**](docs/SourceimagesApi.md#create_source_image) | **POST** /sourceimages/{organization} | Upload new source images.
+*RokkaClientCodegen::SourceimagesApi* | [**create_source_image_meta_dynamic_with_name**](docs/SourceimagesApi.md#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.
+*RokkaClientCodegen::SourceimagesApi* | [**create_source_image_meta_user**](docs/SourceimagesApi.md#create_source_image_meta_user) | **PUT** /sourceimages/{organization}/{hash}/meta/user | Replace the image meta data with new information.
+*RokkaClientCodegen::SourceimagesApi* | [**create_source_image_meta_user_wth_name**](docs/SourceimagesApi.md#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.
+*RokkaClientCodegen::SourceimagesApi* | [**delete_source_image**](docs/SourceimagesApi.md#delete_source_image) | **DELETE** /sourceimages/{organization}/{hash} | Delete a single source image.
+*RokkaClientCodegen::SourceimagesApi* | [**delete_source_image_meta_dynamic_with_name**](docs/SourceimagesApi.md#delete_source_image_meta_dynamic_with_name) | **DELETE** /sourceimages/{organization}/{hash}/meta/dynamic/{metaName} | Deletes a specific dynamic meta data.
+*RokkaClientCodegen::SourceimagesApi* | [**delete_source_image_meta_user**](docs/SourceimagesApi.md#delete_source_image_meta_user) | **DELETE** /sourceimages/{organization}/{hash}/meta/user | Deletes all user meta data.
+*RokkaClientCodegen::SourceimagesApi* | [**delete_source_image_meta_user_with_name**](docs/SourceimagesApi.md#delete_source_image_meta_user_with_name) | **DELETE** /sourceimages/{organization}/{hash}/meta/user/{metaName} | Deletes user meta data for a specified field.
+*RokkaClientCodegen::SourceimagesApi* | [**download_source_image**](docs/SourceimagesApi.md#download_source_image) | **GET** /sourceimages/{organization}/{hash}/download | Download original source image binary.
+*RokkaClientCodegen::SourceimagesApi* | [**get_source_image**](docs/SourceimagesApi.md#get_source_image) | **GET** /sourceimages/{organization}/{hash} | Get information about a source image.
+*RokkaClientCodegen::SourceimagesApi* | [**get_source_image_meta_user**](docs/SourceimagesApi.md#get_source_image_meta_user) | **GET** /sourceimages/{organization}/{hash}/meta/user | Get all user meta data.
+*RokkaClientCodegen::SourceimagesApi* | [**get_source_image_meta_user_with_name**](docs/SourceimagesApi.md#get_source_image_meta_user_with_name) | **GET** /sourceimages/{organization}/{hash}/meta/user/{metaName} | Get user meta for a specific field.
+*RokkaClientCodegen::SourceimagesApi* | [**list_source_images**](docs/SourceimagesApi.md#list_source_images) | **GET** /sourceimages/{organization} | Get all images of an organization, with paging.
+*RokkaClientCodegen::SourceimagesApi* | [**list_source_images_by_binary_hash**](docs/SourceimagesApi.md#list_source_images_by_binary_hash) | **GET** /sourceimages/{organization}/binaryhash/{binaryHash} | Get all images in this organization that match a binaryhash.
+*RokkaClientCodegen::SourceimagesApi* | [**patch_source_image_meta_user**](docs/SourceimagesApi.md#patch_source_image_meta_user) | **PATCH** /sourceimages/{organization}/{hash}/meta/user | Update the specified meta data fields for an image.
+*RokkaClientCodegen::SourceimagesApi* | [**restore_source_image**](docs/SourceimagesApi.md#restore_source_image) | **POST** /sourceimages/{organization}/{hash}/restore | Restore source image including previously set metadata.
+*RokkaClientCodegen::StacksApi* | [**create_stack**](docs/StacksApi.md#create_stack) | **PUT** /stacks/{organization}/{name} | Create a new stack.
+*RokkaClientCodegen::StacksApi* | [**delete_stack**](docs/StacksApi.md#delete_stack) | **DELETE** /stacks/{organization}/{name} | Delete a stack.
+*RokkaClientCodegen::StacksApi* | [**get_stack**](docs/StacksApi.md#get_stack) | **GET** /stacks/{organization}/{name} | Get a single stack.
+*RokkaClientCodegen::StacksApi* | [**list_operations**](docs/StacksApi.md#list_operations) | **GET** /operations | Listing all available operations that can be used in stacks.
+*RokkaClientCodegen::StacksApi* | [**list_stack_options**](docs/StacksApi.md#list_stack_options) | **GET** /stackoptions | List all available options that can be set on stacks.
+*RokkaClientCodegen::StacksApi* | [**list_stacks**](docs/StacksApi.md#list_stacks) | **GET** /stacks/{organization} | Get all stacks of an organization.
+
+
+## Documentation for Models
+
+ - [RokkaClientCodegen::ListSourceImagesResponse](docs/ListSourceImagesResponse.md)
+ - [RokkaClientCodegen::ListStacksResponse](docs/ListStacksResponse.md)
+ - [RokkaClientCodegen::Membership](docs/Membership.md)
+ - [RokkaClientCodegen::Organization](docs/Organization.md)
+ - [RokkaClientCodegen::OrganizationDefinition](docs/OrganizationDefinition.md)
+ - [RokkaClientCodegen::OrganizationOptions](docs/OrganizationOptions.md)
+ - [RokkaClientCodegen::Role](docs/Role.md)
+ - [RokkaClientCodegen::SourceImage](docs/SourceImage.md)
+ - [RokkaClientCodegen::Stack](docs/Stack.md)
+ - [RokkaClientCodegen::StackDefinition](docs/StackDefinition.md)
+ - [RokkaClientCodegen::StackExpression](docs/StackExpression.md)
+ - [RokkaClientCodegen::StackExpressionOverrides](docs/StackExpressionOverrides.md)
+ - [RokkaClientCodegen::StackOperation](docs/StackOperation.md)
+ - [RokkaClientCodegen::StackOperationDescription](docs/StackOperationDescription.md)
+ - [RokkaClientCodegen::StackOptions](docs/StackOptions.md)
+ - [RokkaClientCodegen::User](docs/User.md)
+ - [RokkaClientCodegen::UserDefinition](docs/UserDefinition.md)
+
+
+## Documentation for Authorization
+
+
+### ApiKeyAuth
+
+- **Type**: API key
+- **API key parameter name**: api-key
+- **Location**: HTTP header
+

data/Rakefile

@@ -0,0 +1,8 @@
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/config.json

@@ -0,0 +1,5 @@
+{
+  "gemVersion": "0.0.1",
+  "moduleName": "RokkaClientCodegen",
+  "gemLicense": "MIT"
+}

data/docs/AdminApi.md

@@ -0,0 +1,398 @@
+# RokkaClientCodegen::AdminApi
+
+All URIs are relative to *https://api.rokka.io*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_membership**](AdminApi.md#create_membership) | **PUT** /organizations/{organization}/memberships/{email} | Add a rokka user into an organization.
+[**create_organization**](AdminApi.md#create_organization) | **PUT** /organizations/{organization} | Register a new Organization.
+[**create_organization_options**](AdminApi.md#create_organization_options) | **PUT** /organizations/{organization}/options | Update options for an organization.
+[**create_user**](AdminApi.md#create_user) | **POST** /users | Register new user.
+[**delete_membership**](AdminApi.md#delete_membership) | **DELETE** /organizations/{organization}/memberships/{email} | Remove a user from an organization.
+[**get_membership**](AdminApi.md#get_membership) | **GET** /organizations/{organization}/memberships/{email} | Get information about organization membership of a rokka user.
+[**get_organization**](AdminApi.md#get_organization) | **GET** /organizations/{organization} | Get information about an organization.
+
+
+# **create_membership**
+> Membership create_membership(role, organization, email)
+
+Add a rokka user into an organization.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+role = RokkaClientCodegen::Role.new # Role | Role specification
+
+organization = "organization_example" # String | 
+
+email = "email_example" # String | 
+
+
+begin
+  #Add a rokka user into an organization.
+  result = api_instance.create_membership(role, organization, email)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->create_membership: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **role** | [**Role**](Role.md)| Role specification | 
+ **organization** | **String**|  | 
+ **email** | **String**|  | 
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **create_organization**
+> Organization create_organization(organization, organization_definition)
+
+Register a new Organization.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+organization = "organization_example" # String | Name of the organization to create (must be a web safe string)
+
+organization_definition = RokkaClientCodegen::OrganizationDefinition.new # OrganizationDefinition | Organization information
+
+
+begin
+  #Register a new Organization.
+  result = api_instance.create_organization(organization, organization_definition)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->create_organization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organization** | **String**| Name of the organization to create (must be a web safe string) | 
+ **organization_definition** | [**OrganizationDefinition**](OrganizationDefinition.md)| Organization information | 
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **create_organization_options**
+> Organization create_organization_options(organization, organization_options)
+
+Update options for an organization.
+
+This is currently used for the remote_* options.  See https://rokka.io/documentation/references/stacks.html#loading-images-from-a-remote-url for details.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+organization = "organization_example" # String | Organization name
+
+organization_options = RokkaClientCodegen::OrganizationOptions.new # OrganizationOptions | Organization options
+
+
+begin
+  #Update options for an organization.
+  result = api_instance.create_organization_options(organization, organization_options)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->create_organization_options: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organization** | **String**| Organization name | 
+ **organization_options** | [**OrganizationOptions**](OrganizationOptions.md)| Organization options | 
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **create_user**
+> User create_user(user_definition)
+
+Register new user.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+user_definition = RokkaClientCodegen::UserDefinition.new # UserDefinition | User information
+
+
+begin
+  #Register new user.
+  result = api_instance.create_user(user_definition)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->create_user: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **user_definition** | [**UserDefinition**](UserDefinition.md)| User information | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **delete_membership**
+> delete_membership(organization, email)
+
+Remove a user from an organization.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+organization = "organization_example" # String | 
+
+email = "email_example" # String | 
+
+
+begin
+  #Remove a user from an organization.
+  api_instance.delete_membership(organization, email)
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->delete_membership: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organization** | **String**|  | 
+ **email** | **String**|  | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **get_membership**
+> Membership get_membership(organization, email)
+
+Get information about organization membership of a rokka user.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+organization = "organization_example" # String | 
+
+email = "email_example" # String | 
+
+
+begin
+  #Get information about organization membership of a rokka user.
+  result = api_instance.get_membership(organization, email)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->get_membership: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organization** | **String**|  | 
+ **email** | **String**|  | 
+
+### Return type
+
+[**Membership**](Membership.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+
+# **get_organization**
+> Organization get_organization(organization)
+
+Get information about an organization.
+
+### Example
+```ruby
+# load the gem
+require 'rokka_client_codegen'
+# setup authorization
+RokkaClientCodegen.configure do |config|
+  # Configure API key authorization: ApiKeyAuth
+  config.api_key['api-key'] = 'YOUR API KEY'
+  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
+  #config.api_key_prefix['api-key'] = 'Bearer'
+end
+
+api_instance = RokkaClientCodegen::AdminApi.new
+
+organization = "organization_example" # String | Organization name
+
+
+begin
+  #Get information about an organization.
+  result = api_instance.get_organization(organization)
+  p result
+rescue RokkaClientCodegen::ApiError => e
+  puts "Exception when calling AdminApi->get_organization: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **organization** | **String**| Organization name | 
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[ApiKeyAuth](../README.md#ApiKeyAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+
+