Skip to content
This repository has been archived by the owner on Oct 30, 2023. It is now read-only.

API v1 and v2 updates 2019-2-20 #16

Merged
merged 6 commits into from
Feb 28, 2019
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion config_v1.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv1",
"moduleName": "JCAPIv1",
"gemVersion": "1.3.0"
"gemVersion": "1.4.0"
}
2 changes: 1 addition & 1 deletion config_v2.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"gemName": "jcapiv2",
"moduleName": "JCAPIv2",
"gemVersion": "1.3.0"
"gemVersion": "1.4.0"
}
2 changes: 1 addition & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
version: '2'
services:
swagger-codegen:
image: jimschubert/swagger-codegen-cli:2.3.1
image: swaggerapi/swagger-codegen-cli:2.4.2
volumes:
- ./input:/swagger-api/yaml # volume for input yaml files
- ./output:/swagger-api/out # volume for generated files
Expand Down
2 changes: 1 addition & 1 deletion jcapiv1/.gitignore
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Generated by: https://github.com/swagger-api/swagger-codegen.git
#
#

*.gem
*.rbc
Expand Down
154 changes: 154 additions & 0 deletions jcapiv1/.rubocop.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
# This file is based on https://github.com/rails/rails/blob/master/.rubocop.yml (MIT license)
# Automatically generated by Swagger Codegen (https://github.com/swagger-api/swagger-codegen)
AllCops:
TargetRubyVersion: 2.2
# RuboCop has a bunch of cops enabled by default. This setting tells RuboCop
# to ignore them, so only the ones explicitly set in this file are enabled.
DisabledByDefault: true
Exclude:
- '**/templates/**/*'
- '**/vendor/**/*'
- 'actionpack/lib/action_dispatch/journey/parser.rb'

# Prefer &&/|| over and/or.
Style/AndOr:
Enabled: true

# Do not use braces for hash literals when they are the last argument of a
# method call.
Style/BracesAroundHashParameters:
Enabled: true
EnforcedStyle: context_dependent

# Align `when` with `case`.
Layout/CaseIndentation:
Enabled: true

# Align comments with method definitions.
Layout/CommentIndentation:
Enabled: true

Layout/ElseAlignment:
Enabled: true

Layout/EmptyLineAfterMagicComment:
Enabled: true

# In a regular class definition, no empty lines around the body.
Layout/EmptyLinesAroundClassBody:
Enabled: true

# In a regular method definition, no empty lines around the body.
Layout/EmptyLinesAroundMethodBody:
Enabled: true

# In a regular module definition, no empty lines around the body.
Layout/EmptyLinesAroundModuleBody:
Enabled: true

Layout/FirstParameterIndentation:
Enabled: true

# Use Ruby >= 1.9 syntax for hashes. Prefer { a: :b } over { :a => :b }.
Style/HashSyntax:
Enabled: false

# Method definitions after `private` or `protected` isolated calls need one
# extra level of indentation.
Layout/IndentationConsistency:
Enabled: true
EnforcedStyle: rails

# Two spaces, no tabs (for indentation).
Layout/IndentationWidth:
Enabled: true

Layout/LeadingCommentSpace:
Enabled: true

Layout/SpaceAfterColon:
Enabled: true

Layout/SpaceAfterComma:
Enabled: true

Layout/SpaceAroundEqualsInParameterDefault:
Enabled: true

Layout/SpaceAroundKeyword:
Enabled: true

Layout/SpaceAroundOperators:
Enabled: true

Layout/SpaceBeforeComma:
Enabled: true

Layout/SpaceBeforeFirstArg:
Enabled: true

Style/DefWithParentheses:
Enabled: true

# Defining a method with parameters needs parentheses.
Style/MethodDefParentheses:
Enabled: true

Style/FrozenStringLiteralComment:
Enabled: false
EnforcedStyle: always

# Use `foo {}` not `foo{}`.
Layout/SpaceBeforeBlockBraces:
Enabled: true

# Use `foo { bar }` not `foo {bar}`.
Layout/SpaceInsideBlockBraces:
Enabled: true

# Use `{ a: 1 }` not `{a:1}`.
Layout/SpaceInsideHashLiteralBraces:
Enabled: true

Layout/SpaceInsideParens:
Enabled: true

# Check quotes usage according to lint rule below.
#Style/StringLiterals:
# Enabled: true
# EnforcedStyle: single_quotes

# Detect hard tabs, no hard tabs.
Layout/Tab:
Enabled: true

# Blank lines should not have any spaces.
Layout/TrailingBlankLines:
Enabled: true

# No trailing whitespace.
Layout/TrailingWhitespace:
Enabled: false

# Use quotes for string literals when they are enough.
Style/UnneededPercentQ:
Enabled: true

# Align `end` with the matching keyword or starting expression except for
# assignments, where it should be aligned with the LHS.
Lint/EndAlignment:
Enabled: true
EnforcedStyleAlignWith: variable
AutoCorrect: true

# Use my_method(my_arg) not my_method( my_arg ) or my_method my_arg.
Lint/RequireParentheses:
Enabled: true

Style/RedundantReturn:
Enabled: true
AllowMultipleReturnValues: true

Style/Semicolon:
Enabled: true
AllowAsExpressionSeparator: true
2 changes: 1 addition & 1 deletion jcapiv1/.swagger-codegen/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
2.3.1
2.4.2
21 changes: 12 additions & 9 deletions jcapiv1/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ JCAPIv1 - the Ruby gem for the JumpCloud APIs
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: 1.0
- Package version: 1.3.0
- Package version: 1.4.0
- Build package: io.swagger.codegen.languages.RubyClientCodegen

## Installation
Expand All @@ -23,15 +23,15 @@ gem build jcapiv1.gemspec
Then either install the gem locally:

```shell
gem install ./jcapiv1-1.3.0.gem
gem install ./jcapiv1-1.4.0.gem
```
(for development, run `gem install --dev ./jcapiv1-1.3.0.gem` to install the development dependencies)
(for development, run `gem install --dev ./jcapiv1-1.4.0.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 'jcapiv1', '~> 1.3.0'
gem 'jcapiv1', '~> 1.4.0'

### Install from Git

Expand Down Expand Up @@ -64,16 +64,17 @@ end

api_instance = JCAPIv1::ApplicationsApi.new

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
fields: "fields_example", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
fields: 'fields_example', # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
limit: 56, # Integer | The number of records to return at once.
skip: 56, # Integer | The offset into the records to return.
sort: "The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.", # String |
x_org_id: "" # String |
sort: 'The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.', # String |
filter: 'filter_example' # String | A filter to apply to the query.
x_org_id: '' # String |
}

begin
Expand Down Expand Up @@ -127,6 +128,7 @@ Class | Method | HTTP request | Description
*JCAPIv1::SystemusersApi* | [**systemusers_resetmfa**](docs/SystemusersApi.md#systemusers_resetmfa) | **POST** /systemusers/{id}/resetmfa | Reset a system user's MFA token
*JCAPIv1::SystemusersApi* | [**systemusers_systems_binding_list**](docs/SystemusersApi.md#systemusers_systems_binding_list) | **GET** /systemusers/{id}/systems | List system user binding
*JCAPIv1::SystemusersApi* | [**systemusers_systems_binding_put**](docs/SystemusersApi.md#systemusers_systems_binding_put) | **PUT** /systemusers/{id}/systems | Update a system user binding
*JCAPIv1::SystemusersApi* | [**systemusers_unlock**](docs/SystemusersApi.md#systemusers_unlock) | **POST** /systemusers/{id}/unlock | Unlock a system user
*JCAPIv1::TagsApi* | [**tags_delete**](docs/TagsApi.md#tags_delete) | **DELETE** /tags/{name} | Delete a Tag
*JCAPIv1::TagsApi* | [**tags_get**](docs/TagsApi.md#tags_get) | **GET** /Tags/{name} | List a Tag
*JCAPIv1::TagsApi* | [**tags_list**](docs/TagsApi.md#tags_list) | **GET** /tags | List All Tags
Expand Down Expand Up @@ -158,6 +160,7 @@ Class | Method | HTTP request | Description
- [JCAPIv1::CommandslistResults](docs/CommandslistResults.md)
- [JCAPIv1::Errorresponse](docs/Errorresponse.md)
- [JCAPIv1::Fde](docs/Fde.md)
- [JCAPIv1::Mfa](docs/Mfa.md)
- [JCAPIv1::Organizationslist](docs/Organizationslist.md)
- [JCAPIv1::OrganizationslistResults](docs/OrganizationslistResults.md)
- [JCAPIv1::Radiusserver](docs/Radiusserver.md)
Expand Down
12 changes: 7 additions & 5 deletions jcapiv1/docs/ApplicationsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,17 @@ end

api_instance = JCAPIv1::ApplicationsApi.new

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
fields: "fields_example", # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
fields: 'fields_example', # String | The comma separated fields included in the returned records. If omitted the default list of fields will be returned.
limit: 56, # Integer | The number of records to return at once.
skip: 56, # Integer | The offset into the records to return.
sort: "The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.", # String |
x_org_id: "" # String |
sort: 'The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.', # String |
filter: 'filter_example' # String | A filter to apply to the query.
x_org_id: '' # String |
}

begin
Expand All @@ -59,6 +60,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| The number of records to return at once. | [optional]
**skip** | **Integer**| The offset into the records to return. | [optional]
**sort** | **String**| | [optional] [default to The comma separated fields used to sort the collection. Default sort is ascending, prefix with - to sort descending.]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down
34 changes: 19 additions & 15 deletions jcapiv1/docs/CommandResultsApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,14 +30,14 @@ end

api_instance = JCAPIv1::CommandResultsApi.new

id = "id_example" # String |
id = 'id_example' # String |

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
x_org_id: "" # String |
x_org_id: '' # String |
}

begin
Expand Down Expand Up @@ -78,7 +78,7 @@ Name | Type | Description | Notes

List an individual Command result

This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```
This endpoint returns a specific command result. #### Sample Request ``` curl -X GET https://console.jumpcloud.com/api/commandresults/{CommandResultID} \\ -H 'Accept: application/json' \\ -H 'Content-Type: application/json' \\ -H 'x-api-key: {API_KEY}' ```

### Example
```ruby
Expand All @@ -94,15 +94,16 @@ end

api_instance = JCAPIv1::CommandResultsApi.new

id = "id_example" # String |
id = 'id_example' # String |

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
x_org_id: "" # String |
fields: '', # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
filter: 'filter_example' # String | A filter to apply to the query.
x_org_id: '' # String |
}

begin
Expand All @@ -122,6 +123,7 @@ Name | Type | Description | Notes
**content_type** | **String**| | [default to application/json]
**accept** | **String**| | [default to application/json]
**fields** | **String**| Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down Expand Up @@ -160,16 +162,17 @@ end

api_instance = JCAPIv1::CommandResultsApi.new

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
fields: "", # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
fields: '', # String | Use a space seperated string of field parameters to include the data in the response. If omitted the default list of fields will be returned.
limit: 10, # Integer | The number of records to return at once. Limited to 100.
skip: 0, # Integer | The offset into the records to return.
sort: "" # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
x_org_id: "" # String |
sort: '', # String | Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending.
filter: 'filter_example' # String | A filter to apply to the query.
x_org_id: '' # String |
}

begin
Expand All @@ -191,6 +194,7 @@ Name | Type | Description | Notes
**limit** | **Integer**| The number of records to return at once. Limited to 100. | [optional] [default to 10]
**skip** | **Integer**| The offset into the records to return. | [optional] [default to 0]
**sort** | **String**| Use space separated sort parameters to sort the collection. Default sort is ascending. Prefix with `-` to sort descending. | [optional] [default to ]
**filter** | **String**| A filter to apply to the query. | [optional]
**x_org_id** | **String**| | [optional] [default to ]

### Return type
Expand Down
8 changes: 4 additions & 4 deletions jcapiv1/docs/CommandTriggersApi.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,14 @@ end

api_instance = JCAPIv1::CommandTriggersApi.new

triggername = "triggername_example" # String |
triggername = 'triggername_example' # String |

content_type = "application/json" # String |
content_type = 'application/json' # String |

accept = "application/json" # String |
accept = 'application/json' # String |

opts = {
x_org_id: "" # String |
x_org_id: '' # String |
}

begin
Expand Down
Loading