Skip to content

Commit 000ce09

Browse files
tsmithjctsmithjc
committed
Generate v1 API using latest YAML file
1 parent e8dc37b commit 000ce09

File tree

122 files changed

+12738
-5
lines changed

Some content is hidden

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

122 files changed

+12738
-5
lines changed

‎CONTRIBUTING.md

+8-5
Original file line numberDiff line numberDiff line change
@@ -9,19 +9,22 @@ We're currently using the version 2.3.1 of swagger-codegen.
99

1010
Copy the API yaml files to the local `/input` directory.
1111

12-
The API v2 json/yaml spec can be found using the StopLight export link on our documentation page: `https://docs.jumpcloud.com/2.0`.
12+
The API v1 and v2 yaml specs can be found using the StopLight export links on our documentation pages: `https://docs.jumpcloud.com/1.0` and `https://docs.jumpcloud.com/2.0`.
1313

14-
Update the version number for each package in `config_v2.json`.
14+
Update the version number for each package in `config_v1.json` and `config_v2.json`.
1515

16-
To generate the API v2 client, run the command below (assuming your API v2 yaml file is `input/index2.yaml`):
16+
To generate the API v1 client, run the commands below (assuming your API v1 and v2 yaml files are `input/index1.yaml` and `input/index2.yaml`):
1717

1818
```
19+
docker-compose run --rm swagger-codegen generate -i /swagger-api/yaml/index1.yaml -l go -c /config/config_v1.json -o /swagger-api/out/v1
1920
docker-compose run --rm swagger-codegen generate -i /swagger-api/yaml/index2.yaml -l go -c /config/config_v2.json -o /swagger-api/out/v2
2021
```
21-
This will generate the API v2 client files under `output/v2`
22+
This will generate the API v1 and v2 client files under `output/v1` and `output/v2`.
2223

23-
Once you are satisfied with the generated API client, you can replace the existing files under the `v2` folder with your generated files:
24+
Once you are satisfied with the generated API client, you can replace the existing files under the `v1` folder with your generated files:
2425
```
26+
rm -rf v1
27+
mv output/v1 .
2528
rm -rf v2
2629
mv output/v2 .
2730
```

‎config_v1.json

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
{
2+
"packageName": "v1",
3+
"packageVersion": "1.26.0"
4+
}

‎v1/.gitignore

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Compiled Object files, Static and Dynamic libs (Shared Objects)
2+
*.o
3+
*.a
4+
*.so
5+
6+
# Folders
7+
_obj
8+
_test
9+
10+
# Architecture specific extensions/prefixes
11+
*.[568vq]
12+
[568vq].out
13+
14+
*.cgo1.go
15+
*.cgo2.c
16+
_cgo_defun.c
17+
_cgo_gotypes.go
18+
_cgo_export.*
19+
20+
_testmain.go
21+
22+
*.exe
23+
*.test
24+
*.prof

‎v1/.swagger-codegen-ignore

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Swagger Codegen Ignore
2+
# Generated by swagger-codegen https://github.com/swagger-api/swagger-codegen
3+
4+
# Use this file to prevent files from being overwritten by the generator.
5+
# The patterns follow closely to .gitignore or .dockerignore.
6+
7+
# As an example, the C# client generator defines ApiClient.cs.
8+
# You can make changes and tell Swagger Codgen to ignore just this file by uncommenting the following line:
9+
#ApiClient.cs
10+
11+
# You can match any string of characters against a directory, file or extension with a single asterisk (*):
12+
#foo/*/qux
13+
# The above matches foo/bar/qux and foo/baz/qux, but not foo/bar/baz/qux
14+
15+
# You can recursively match patterns against a directory, file or extension with a double asterisk (**):
16+
#foo/**/qux
17+
# This matches foo/bar/qux, foo/baz/qux, and foo/bar/baz/qux
18+
19+
# You can also negate patterns with an exclamation (!).
20+
# For example, you can ignore all files in a docs folder with the file extension .md:
21+
#docs/*.md
22+
# Then explicitly reverse the ignore rule for a single file:
23+
#!docs/README.md

‎v1/.swagger-codegen/VERSION

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
2.3.1

‎v1/.travis.yml

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
language: go
2+
3+
install:
4+
- go get -d -v .
5+
6+
script:
7+
- go build -v ./
8+

‎v1/README.md

+128
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# Go API client for v1
2+
3+
V1 & V2 versions of JumpCloud's API. The previous version of JumpCloud's API. This set of endpoints allows JumpCloud customers to manage commands, systems, & system users.
4+
5+
## Overview
6+
This API client was generated by the [swagger-codegen](https://github.com/swagger-api/swagger-codegen) project. By using the [swagger-spec](https://github.com/swagger-api/swagger-spec) from a remote server, you can easily generate an API client.
7+
8+
- API version: 1.0
9+
- Package version: 1.26.0
10+
- Build package: io.swagger.codegen.languages.GoClientCodegen
11+
12+
## Installation
13+
Put the package under your project folder and add the following in import:
14+
```
15+
"./v1"
16+
```
17+
18+
## Documentation for API Endpoints
19+
20+
All URIs are relative to *https://console.jumpcloud.com/api*
21+
22+
Class | Method | HTTP request | Description
23+
------------ | ------------- | ------------- | -------------
24+
*ApplicationsApi* | [**ApplicationsList**](docs/ApplicationsApi.md#applicationslist) | **Get** /applications | Applications
25+
*CommandResultsApi* | [**CommandResultsDelete**](docs/CommandResultsApi.md#commandresultsdelete) | **Delete** /commandresults/{id} | Delete a Command result
26+
*CommandResultsApi* | [**CommandResultsGet**](docs/CommandResultsApi.md#commandresultsget) | **Get** /commandresults/{id} | List an individual Command result
27+
*CommandResultsApi* | [**CommandResultsList**](docs/CommandResultsApi.md#commandresultslist) | **Get** /commandresults | List all Command Results
28+
*CommandTriggersApi* | [**CommandTriggerWebhookPost**](docs/CommandTriggersApi.md#commandtriggerwebhookpost) | **Post** /command/trigger/{triggername} | Launch a command via a Trigger
29+
*CommandsApi* | [**CommandFileGet**](docs/CommandsApi.md#commandfileget) | **Get** /files/command/{id} | Get a Command File
30+
*CommandsApi* | [**CommandsDelete**](docs/CommandsApi.md#commandsdelete) | **Delete** /commands/{id} | Delete a Command
31+
*CommandsApi* | [**CommandsGet**](docs/CommandsApi.md#commandsget) | **Get** /commands/{id} | List an individual Command
32+
*CommandsApi* | [**CommandsList**](docs/CommandsApi.md#commandslist) | **Get** /commands/ | List All Commands
33+
*CommandsApi* | [**CommandsPost**](docs/CommandsApi.md#commandspost) | **Post** /commands/ | Create A Command
34+
*CommandsApi* | [**CommandsPut**](docs/CommandsApi.md#commandsput) | **Put** /commands/{id} | Update a Command
35+
*OrganizationsApi* | [**OrganizationList**](docs/OrganizationsApi.md#organizationlist) | **Get** /organizations | Get Organization Details
36+
*RadiusServersApi* | [**RadiusServersList**](docs/RadiusServersApi.md#radiusserverslist) | **Get** /radiusservers | List Radius Servers
37+
*RadiusServersApi* | [**RadiusServersPost**](docs/RadiusServersApi.md#radiusserverspost) | **Post** /radiusservers | Create a Radius Server
38+
*RadiusServersApi* | [**RadiusServersPut**](docs/RadiusServersApi.md#radiusserversput) | **Put** /radiusservers:id | Update Radius Servers
39+
*SearchApi* | [**SearchSystemsPost**](docs/SearchApi.md#searchsystemspost) | **Post** /search/systems | Search Systems
40+
*SearchApi* | [**SearchSystemusersPost**](docs/SearchApi.md#searchsystemuserspost) | **Post** /search/systemusers | Search System Users
41+
*SystemsApi* | [**SystemsDelete**](docs/SystemsApi.md#systemsdelete) | **Delete** /systems/{id} | Delete a System
42+
*SystemsApi* | [**SystemsGet**](docs/SystemsApi.md#systemsget) | **Get** /systems/{id} | List an individual system
43+
*SystemsApi* | [**SystemsList**](docs/SystemsApi.md#systemslist) | **Get** /systems | List All Systems
44+
*SystemsApi* | [**SystemsPut**](docs/SystemsApi.md#systemsput) | **Put** /systems/{id} | Update a system
45+
*SystemsApi* | [**SystemsSystemusersBindingList**](docs/SystemsApi.md#systemssystemusersbindinglist) | **Get** /systems/{id}/systemusers | List system user bindings
46+
*SystemsApi* | [**SystemsSystemusersBindingPut**](docs/SystemsApi.md#systemssystemusersbindingput) | **Put** /systems/{id}/systemusers | Update a system's or user's binding
47+
*SystemusersApi* | [**SystemusersDelete**](docs/SystemusersApi.md#systemusersdelete) | **Delete** /systemusers/{id} | Delete a system user
48+
*SystemusersApi* | [**SystemusersGet**](docs/SystemusersApi.md#systemusersget) | **Get** /systemusers/{id} | List a system user
49+
*SystemusersApi* | [**SystemusersList**](docs/SystemusersApi.md#systemuserslist) | **Get** /systemusers | List all system users
50+
*SystemusersApi* | [**SystemusersPost**](docs/SystemusersApi.md#systemuserspost) | **Post** /systemusers | Create a system user
51+
*SystemusersApi* | [**SystemusersPut**](docs/SystemusersApi.md#systemusersput) | **Put** /systemusers/{id} | Update a system user
52+
*SystemusersApi* | [**SystemusersResetmfa**](docs/SystemusersApi.md#systemusersresetmfa) | **Post** /systemusers/{id}/resetmfa | Reset a system user's MFA token
53+
*SystemusersApi* | [**SystemusersSystemsBindingList**](docs/SystemusersApi.md#systemuserssystemsbindinglist) | **Get** /systemusers/{id}/systems | List system user binding
54+
*SystemusersApi* | [**SystemusersSystemsBindingPut**](docs/SystemusersApi.md#systemuserssystemsbindingput) | **Put** /systemusers/{id}/systems | Update a system user binding
55+
*TagsApi* | [**TagsDelete**](docs/TagsApi.md#tagsdelete) | **Delete** /tags/{name} | Delete a Tag
56+
*TagsApi* | [**TagsGet**](docs/TagsApi.md#tagsget) | **Get** /Tags/{name} | List a Tag
57+
*TagsApi* | [**TagsList**](docs/TagsApi.md#tagslist) | **Get** /tags | List All Tags
58+
*TagsApi* | [**TagsPost**](docs/TagsApi.md#tagspost) | **Post** /tags | Create a Tag
59+
*TagsApi* | [**TagsPut**](docs/TagsApi.md#tagsput) | **Put** /Tag/{name} | Update a Tag
60+
61+
62+
## Documentation For Models
63+
64+
- [Application](docs/Application.md)
65+
- [ApplicationConfig](docs/ApplicationConfig.md)
66+
- [ApplicationConfigConstantAttributes](docs/ApplicationConfigConstantAttributes.md)
67+
- [ApplicationConfigConstantAttributesValue](docs/ApplicationConfigConstantAttributesValue.md)
68+
- [ApplicationConfigDatabaseAttributes](docs/ApplicationConfigDatabaseAttributes.md)
69+
- [ApplicationConfigIdpEntityId](docs/ApplicationConfigIdpEntityId.md)
70+
- [ApplicationConfigIdpEntityIdTooltip](docs/ApplicationConfigIdpEntityIdTooltip.md)
71+
- [ApplicationConfigIdpEntityIdTooltipVariables](docs/ApplicationConfigIdpEntityIdTooltipVariables.md)
72+
- [Applicationslist](docs/Applicationslist.md)
73+
- [Body](docs/Body.md)
74+
- [Command](docs/Command.md)
75+
- [Commandfilereturn](docs/Commandfilereturn.md)
76+
- [CommandfilereturnResults](docs/CommandfilereturnResults.md)
77+
- [Commandresult](docs/Commandresult.md)
78+
- [CommandresultResponse](docs/CommandresultResponse.md)
79+
- [CommandresultResponseData](docs/CommandresultResponseData.md)
80+
- [Commandresultslist](docs/Commandresultslist.md)
81+
- [Commandslist](docs/Commandslist.md)
82+
- [CommandslistResults](docs/CommandslistResults.md)
83+
- [InlineResponse400](docs/InlineResponse400.md)
84+
- [Organizationslist](docs/Organizationslist.md)
85+
- [OrganizationslistResults](docs/OrganizationslistResults.md)
86+
- [Radiusserver](docs/Radiusserver.md)
87+
- [Radiusserverpost](docs/Radiusserverpost.md)
88+
- [Radiusserverput](docs/Radiusserverput.md)
89+
- [Radiusserverslist](docs/Radiusserverslist.md)
90+
- [Search](docs/Search.md)
91+
- [System](docs/System.md)
92+
- [SystemNetworkInterfaces](docs/SystemNetworkInterfaces.md)
93+
- [Systemput](docs/Systemput.md)
94+
- [SystemputAgentBoundMessages](docs/SystemputAgentBoundMessages.md)
95+
- [Systemslist](docs/Systemslist.md)
96+
- [Systemuser](docs/Systemuser.md)
97+
- [Systemuserbinding](docs/Systemuserbinding.md)
98+
- [Systemuserbindingsput](docs/Systemuserbindingsput.md)
99+
- [Systemuserput](docs/Systemuserput.md)
100+
- [Systemuserputpost](docs/Systemuserputpost.md)
101+
- [Systemuserreturn](docs/Systemuserreturn.md)
102+
- [Systemuserslist](docs/Systemuserslist.md)
103+
- [Tag](docs/Tag.md)
104+
- [Tagpost](docs/Tagpost.md)
105+
- [Tagput](docs/Tagput.md)
106+
- [Tagslist](docs/Tagslist.md)
107+
- [Usersystembinding](docs/Usersystembinding.md)
108+
- [Usersystembindingsput](docs/Usersystembindingsput.md)
109+
110+
111+
## Documentation For Authorization
112+
113+
## x-api-key
114+
- **Type**: API key
115+
116+
Example
117+
```
118+
auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{
119+
Key: "APIKEY",
120+
Prefix: "Bearer", // Omit if not necessary.
121+
})
122+
r, err := client.Service.Operation(auth, args)
123+
```
124+
125+
## Author
126+
127+
128+

0 commit comments

Comments
 (0)