Skip to content

Commit 1da0f35

Browse files
developerstevedevelopersteve
committed
spec updates and migration to openapi-generator
1 parent dc2aaa3 commit 1da0f35

File tree

572 files changed

+31229
-9108
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

572 files changed

+31229
-9108
lines changed

‎README.md

+144-90
Large diffs are not rendered by default.

‎Rakefile

+2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
require "bundler/gem_tasks"
2+
13
begin
24
require 'rspec/core/rake_task'
35

‎TelstraTPN.gemspec

+8-8
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
# -*- encoding: utf-8 -*-
2-
#
2+
33
=begin
44
#Telstra Programmable Network API
55
66
#Telstra Programmable Network is a self-provisioning platform that allows its users to create on-demand connectivity services between multiple end-points and add various network functions to those services. Programmable Network enables to connectivity to a global ecosystem of networking services as well as public and private cloud services. Once you are connected to the platform on one or more POPs (points of presence), you can start creating those services based on the use case that you want to accomplish. The Programmable Network API is available to all customers who have registered to use the Programmable Network. To register, please contact your account representative.
77
8-
OpenAPI spec version: 2.1.3
9-
10-
Generated by: https://github.com/swagger-api/swagger-codegen.git
11-
Swagger Codegen version: unset
8+
OpenAPI spec version: 2.4.2
9+
Contact: [email protected]
10+
Generated by: https://openapi-generator.tech
11+
OpenAPI Generator version: 3.1.2
1212
1313
=end
1414

@@ -20,11 +20,11 @@ Gem::Specification.new do |s|
2020
s.version = TelstraTPN::VERSION
2121
s.platform = Gem::Platform::RUBY
2222
s.authors = ["Telstra"]
23-
s.email = [""]
23+
s.email = ["[email protected]"]
2424
s.homepage = "https://dev.telstra.com"
2525
s.summary = "Telstra Programmable Network API Ruby Gem"
2626
s.description = "Telstra Programmable Network is a self-provisioning platform that allows its users to create on-demand connectivity services between multiple end-points and add various network functions to those services. Programmable Network enables to connectivity to a global ecosystem of networking services as well as public and private cloud services. Once you are connected to the platform on one or more POPs (points of presence), you can start creating those services based on the use case that you want to accomplish. The Programmable Network API is available to all customers who have registered to use the Programmable Network. To register, please contact your account representative."
27-
s.license = "Apache2"
27+
s.license = 'Apache2'
2828
s.required_ruby_version = ">= 1.9"
2929

3030
s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
@@ -38,7 +38,7 @@ Gem::Specification.new do |s|
3838
s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
3939
s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
4040

41-
s.files = `find *`.split("\n").uniq.sort.select{|f| !f.empty? }
41+
s.files = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
4242
s.test_files = `find spec/*`.split("\n")
4343
s.executables = []
4444
s.require_paths = ["lib"]

‎docs/Eis100EndpointsAssignTopologyTagRequest.md ‎docs/Assigntopotagrequest.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TelstraTPN::Eis100EndpointsAssignTopologyTagRequest
1+
# TelstraTPN::Assigntopotagrequest
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/AuthValidatetokenResponse.md

-14
This file was deleted.

‎docs/AuthenticationApi.md

+23-24
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,12 @@ All URIs are relative to *https://penapi.pacnetconnect.com*
44

55
Method | HTTP request | Description
66
------------- | ------------- | -------------
7-
[**auth_generatetoken_post**](AuthenticationApi.md#auth_generatetoken_post) | **POST** /1.0.0/auth/generatetoken | Create an authentication token
8-
[**auth_validatetoken_get**](AuthenticationApi.md#auth_validatetoken_get) | **GET** /1.0.0/auth/validatetoken | Validate authentication token
7+
[**generate_token**](AuthenticationApi.md#generate_token) | **POST** /1.0.0/auth/generatetoken | Create an authentication token
8+
[**validate_token**](AuthenticationApi.md#validate_token) | **GET** /1.0.0/auth/validatetoken | Validate authentication token
99

1010

11-
# **auth_generatetoken_post**
12-
> AuthGeneratetokenResponse auth_generatetoken_post(grant_type, username, password)
13-
14-
Create an authentication token
11+
# **generate_token**
12+
> InlineResponse20015 generate_token(grant_type, username, password)
1513
1614
Create an authentication token
1715

@@ -21,34 +19,30 @@ Create an authentication token
2119
require 'TelstraTPN'
2220

2321
api_instance = TelstraTPN::AuthenticationApi.new
24-
25-
grant_type = "grant_type_example" # String |
26-
27-
username = "username_example" # String |
28-
29-
password = "password_example" # String |
30-
22+
grant_type = 'password' # String |
23+
username = 'username_example' # String |
24+
password = 'password_example' # String |
3125

3226
begin
3327
#Create an authentication token
34-
result = api_instance.auth_generatetoken_post(grant_type, username, password)
28+
result = api_instance.generate_token(grant_type, username, password)
3529
p result
3630
rescue TelstraTPN::ApiError => e
37-
puts "Exception when calling AuthenticationApi->auth_generatetoken_post: #{e}"
31+
puts "Exception when calling AuthenticationApi->generate_token: #{e}"
3832
end
3933
```
4034

4135
### Parameters
4236

4337
Name | Type | Description | Notes
4438
------------- | ------------- | ------------- | -------------
45-
**grant_type** | **String**| |
39+
**grant_type** | **String**| | [default to 'password']
4640
**username** | **String**| |
4741
**password** | **String**| |
4842

4943
### Return type
5044

51-
[**AuthGeneratetokenResponse**](AuthGeneratetokenResponse.md)
45+
[**InlineResponse20015**](InlineResponse20015.md)
5246

5347
### Authorization
5448

@@ -61,8 +55,8 @@ No authorization required
6155

6256

6357

64-
# **auth_validatetoken_get**
65-
> AuthValidatetokenResponse auth_validatetoken_get
58+
# **validate_token**
59+
> InlineResponse20016 validate_token
6660
6761
Validate authentication token
6862

@@ -72,15 +66,20 @@ Validate the authentication token and get information about the user (roles, per
7266
```ruby
7367
# load the gem
7468
require 'TelstraTPN'
69+
# setup authorization
70+
TelstraTPN.configure do |config|
71+
# Configure OAuth2 access token for authorization: oAuth2
72+
config.access_token = 'YOUR ACCESS TOKEN'
73+
end
7574

7675
api_instance = TelstraTPN::AuthenticationApi.new
7776

7877
begin
7978
#Validate authentication token
80-
result = api_instance.auth_validatetoken_get
79+
result = api_instance.validate_token
8180
p result
8281
rescue TelstraTPN::ApiError => e
83-
puts "Exception when calling AuthenticationApi->auth_validatetoken_get: #{e}"
82+
puts "Exception when calling AuthenticationApi->validate_token: #{e}"
8483
end
8584
```
8685

@@ -89,15 +88,15 @@ This endpoint does not need any parameter.
8988

9089
### Return type
9190

92-
[**AuthValidatetokenResponse**](AuthValidatetokenResponse.md)
91+
[**InlineResponse20016**](InlineResponse20016.md)
9392

9493
### Authorization
9594

96-
No authorization required
95+
[oAuth2](../README.md#oAuth2)
9796

9897
### HTTP request headers
9998

100-
- **Content-Type**: application/json
99+
- **Content-Type**: Not defined
101100
- **Accept**: application/json
102101

103102

‎docs/Backup.md

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# TelstraTPN::Backup
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**backup_name** | **String** | User-defined name referring to the backup | [optional]
7+
**uuid** | **String** | UUID of the backup instance | [optional]
8+
**vnf_uuid** | **String** | UUID of the VNF being backed up | [optional]
9+
**glance_image_id** | **String** | UUID of the underlying image id for the backup | [optional]
10+
**backup_schedule_uuid** | **String** | | [optional]
11+
**total_interfaces** | **Integer** | Number of virtual interfaces active when the VNF was backed up | [optional]
12+
**backup_started_at** | **String** | Time at which backup was started YYYY-MM-DD HH:MM:SS.S | [optional]
13+
**backup_completed_at** | **String** | Time at which backup was completed YYYY-MM-DD HH:MM:SS.S | [optional]
14+
**backup_restored_at** | **String** | Time at which backup was most recently restored YYYY-MM-DD HH:MM:SS.S | [optional]
15+
**backup_restored_by** | **String** | UUID of the user who most recently restored the backup | [optional]
16+
**replace_backup_uuid** | **String** | UUID of the backup that the current backup replaced | [optional]
17+
**status** | **String** | Description of the current state of the backup | [optional]
18+
**status_code** | **String** | \"Unique code representing the current state of the backup: CRG=Creating, CRE=Created, DLG=Deleting, DEL=Deleted, REG=Restoring, ACT=Active/Restored\" | [optional]
19+
20+

‎docs/Backuprequest.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# TelstraTPN::Backuprequest
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**vnf_uuid** | **String** | |
7+
**backup_name** | **String** | |
8+
**replace_backup_uuid** | **String** | | [optional]
9+
10+

‎docs/InventoryLinksContractResponse.md ‎docs/BandwidthKbs.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# TelstraTPN::InventoryLinksContractResponse
1+
# TelstraTPN::BandwidthKbs
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**params** | [**Params31**](Params31.md) | | [optional]
76

87

‎docs/Model100InventoryLinksContractResponse.md ‎docs/BandwidthMbs.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
1-
# TelstraTPN::Model100InventoryLinksContractResponse
1+
# TelstraTPN::BandwidthMbs
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**params** | [**Params31**](Params31.md) | | [optional]
76

87

‎docs/Body.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**renewal_option** | **Integer** | \"Renewal Option: 0=Auto Disconnect, 1=Auto Renew, 2=Pay per hour\" | [optional]
7+
8+

‎docs/Body1.md

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# TelstraTPN::Body1
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**bandwidth** | [**BandwidthMbs**](BandwidthMbs.md) | | [optional]
7+
**duration** | [**DurationHrs**](DurationHrs.md) | | [optional]
8+
**renewal_option** | [**RenewalOption**](RenewalOption.md) | | [optional]
9+
10+

‎docs/Body10.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body10
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**name** | **String** | | [optional]
7+
8+

‎docs/Body11.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body11
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**topology_tag** | **String** | | [optional]
7+
8+

‎docs/Ttms100TopologyTagRequest.md ‎docs/Body12.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
# TelstraTPN::Ttms100TopologyTagRequest
1+
# TelstraTPN::Body12
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**name** | **String** | | [optional]
76
**description** | **String** | | [optional]
7+
**name** | **String** | | [optional]
88

99

‎docs/Body13.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# TelstraTPN::Body13
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**description** | **String** | | [optional]
7+
**name** | **String** | | [optional]
8+
9+

‎docs/Body14.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# TelstraTPN::Body14
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**description** | **String** | | [optional]
7+
**name** | **String** | | [optional]
8+
9+

‎docs/Body15.md

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# TelstraTPN::Body15
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**description** | **String** | | [optional]
7+
**name** | **String** | | [optional]
8+
9+

‎docs/Body16.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body16
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**reboot_type** | **String** | | [optional]
7+
8+

‎docs/Body2.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body2
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**renewal_option** | [**RenewalOption**](RenewalOption.md) | | [optional]
7+
8+

‎docs/Body3.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# TelstraTPN::Body3
2+
3+
## Properties
4+
Name | Type | Description | Notes
5+
------------ | ------------- | ------------- | -------------
6+
**renewal_option** | [**RenewalOption**](RenewalOption.md) | | [optional]
7+
8+

‎docs/InventoryRegularendpointRequest.md ‎docs/Body4.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# TelstraTPN::InventoryRegularendpointRequest
1+
# TelstraTPN::Body4
22

33
## Properties
44
Name | Type | Description | Notes

‎docs/InventoryRegularvportRequest.md ‎docs/Body5.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
1-
# TelstraTPN::InventoryRegularvportRequest
1+
# TelstraTPN::Body5
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6-
**vporttype** | **String** | | [optional]
76
**endpointuuid** | **String** | | [optional]
8-
**vportvalue** | [**Vportvalue**](Vportvalue.md) | | [optional]
7+
**vporttype** | **String** | | [optional]
98

109

‎docs/InventoryVnfVportRequest.md ‎docs/Body6.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# TelstraTPN::InventoryVnfVportRequest
1+
# TelstraTPN::Body6
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
66
**customeruuid** | **String** | | [optional]
7-
**vnfuuid** | **String** | | [optional]
87
**management_port** | **BOOLEAN** | | [optional]
8+
**vnfuuid** | **String** | | [optional]
99

1010

‎docs/InventoryVnfendpointRequest.md ‎docs/Body7.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# TelstraTPN::InventoryVnfendpointRequest
1+
# TelstraTPN::Body7
22

33
## Properties
44
Name | Type | Description | Notes
55
------------ | ------------- | ------------- | -------------
6+
**config** | **String** | Boot configuration for VNF, base64 encoded |
67
**customeruuid** | **String** | |
7-
**imageuuid** | **Integer** | |
8-
**flavoruuid** | **Integer** | |
98
**datacenteruuid** | **String** | |
10-
**config** | **String** | Boot configuration for VNF, base64 encoded |
9+
**flavoruuid** | **Integer** | |
10+
**imageuuid** | **Integer** | |
1111
**topology_tag_uuid** | **String** | | [optional]
1212

1313

0 commit comments

Comments
 (0)