Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Devrel 1471 #63

Open
wants to merge 28 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
0a8214a
starting point for generate docs
darrell-thobe-sp Feb 13, 2024
b6d93d0
adding more for generate docs
darrell-thobe-sp Mar 6, 2024
86428d6
update generator to 7.4.0 and add api docs
darrell-thobe-sp Mar 18, 2024
ee15fd8
update tests mustache to fix some errors
darrell-thobe-sp Mar 19, 2024
79f6ec5
Merge branch 'main' into devrel-1471
darrell-thobe-sp Mar 19, 2024
175778c
fix issues with isNil function
darrell-thobe-sp Mar 19, 2024
81cfdf7
fix for model_anyof.mustache
darrell-thobe-sp Mar 19, 2024
dc4763d
remove unused import from configuration.mustache
darrell-thobe-sp Mar 19, 2024
8e8268e
changes to doc files to fix linking, upate post script to fix docs fo…
darrell-thobe-sp Mar 21, 2024
176d3fb
fix merge conflicts
darrell-thobe-sp Mar 21, 2024
9905295
pull latest from api-specs
darrell-thobe-sp Mar 21, 2024
9817e76
update postscript
darrell-thobe-sp Mar 21, 2024
dbb1da1
update slug path for doc files
darrell-thobe-sp Mar 21, 2024
00c8a16
udpate to fix linking in models markdown files
darrell-thobe-sp Mar 22, 2024
0d5aabf
pulled in api spec changes and added updates for fixing linking issue…
darrell-thobe-sp Mar 28, 2024
bf9dda2
Merge branch 'main' into devrel-1471
darrell-thobe-sp Mar 28, 2024
d449765
pull in spec changes
darrell-thobe-sp Apr 1, 2024
96e4437
Merge branch 'main' into devrel-1471
darrell-thobe-sp Apr 1, 2024
30237f7
pull in latest spec changes
darrell-thobe-sp Apr 16, 2024
6f6c39a
Merge branch 'main' into devrel-1471
darrell-thobe-sp Apr 16, 2024
36b2212
pull changes from api-specs
darrell-thobe-sp Apr 19, 2024
b735468
merge main and fix conflicts
darrell-thobe-sp Apr 19, 2024
c49ee84
spec changes
darrell-thobe-sp Apr 23, 2024
a7db489
merge main fix conflicts
darrell-thobe-sp Apr 23, 2024
481f799
update post script for file path on linux
darrell-thobe-sp Apr 23, 2024
42af979
remove unused param from config.yaml
darrell-thobe-sp Apr 23, 2024
9e2d225
Merge branch 'main' into devrel-1471
darrell-thobe-sp Apr 23, 2024
eb2e3c5
fix merge conflicts
darrell-thobe-sp Apr 23, 2024
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
  •  
  •  
  •  
The diff you're trying to view is too large. We only load the first 3000 changed files.
60 changes: 60 additions & 0 deletions .github/workflows/push-sdk-docs-to-dev-portal.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
name: "Push GO SDK Docs to Developer Portal"

on:
push:
branches:
- main
workflow_dispatch:

jobs:
push_spec_workflow:
name: Push API spec changes
runs-on: ubuntu-latest
steps:
# Checkout the master branch request to run rsync
- name: Checkout PR branch
uses: actions/checkout@v2
with:
ref: ${{ github.ref }}
path: go-sdk

# Checkout the main branch of the developer portal to push changes
- name: Checkout API Specs Repo
uses: actions/checkout@v2
with:
repository: sailpoint-oss/developer.sailpoint.com
path: developer-community
ref: main

- name: Install rsync
run: |
sudo apt install rsync grsync

- name: Sync files between folders
run: |
CURRENT_V3_SPEC_PATH="go-sdk/api_v3/docs"
NEW_V3_API_SPEC_PATH="developer-community/docs/tools/sdk/go/V3"

CURRENT_BETA_SPEC_PATH="go-sdk/api_beta/docs"
NEW_BETA_API_SPEC_PATH="developer-community/docs/tools/sdk/go/Beta"

rsync -cav --delete $CURRENT_V3_SPEC_PATH $NEW_V3_API_SPEC_PATH
rsync -cav --delete $CURRENT_BETA_SPEC_PATH $NEW_BETA_API_SPEC_PATH

cd developer-community
git status

git config --unset-all http.https://github.com/.extraheader
git config --local user.email "[email protected]"
git config --local user.name "developer-relations-sp"

git add .
git commit -m "Update to golang SDK docs: ${{ github.run_id }}"

git status

git remote set-url origin https://${{secrets.DEVREL_SERVICE_TOKEN}}@github.com/sailpoint-oss/developer.sailpoint.com.git

git remote -v

git push
2 changes: 1 addition & 1 deletion api_beta/.openapi-generator/VERSION
Original file line number Diff line number Diff line change
@@ -1 +1 @@
7.1.0
7.4.0
27 changes: 14 additions & 13 deletions api_beta/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,29 +6,30 @@ Use these APIs to interact with the Identity Security Cloud platform to achieve
This API client was generated by the [OpenAPI Generator](https://openapi-generator.tech) project. By using the [OpenAPI-spec](https://www.openapis.org/) from a remote server, you can easily generate an API client.

- API version: 3.1.0-beta
- Package version: 2.0.4
- Package version: 2.0.3
- Generator version: 7.4.0
- Build package: org.openapitools.codegen.languages.GoClientCodegen
For more information, please visit [https://developer.sailpoint.com/discuss/api-help](https://developer.sailpoint.com/discuss/api-help)

## Installation

Install the following dependencies:

```shell
```sh
go get github.com/stretchr/testify/assert
go get golang.org/x/oauth2
go get golang.org/x/net/context
```

Put the package under your project folder and add the following in import:

```golang
```go
import api_beta "github.com/sailpoint-oss/golang-sdk/v2"
```

To use a proxy, set the environment variable `HTTP_PROXY`:

```golang
```go
os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")
```

Expand All @@ -40,15 +41,15 @@ Default configuration comes with `Servers` field that contains server objects as

For using other server than the one defined on index 0 set context value `api_beta.ContextServerIndex` of type `int`.

```golang
```go
ctx := context.WithValue(context.Background(), api_beta.ContextServerIndex, 1)
```

### Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value `api_beta.ContextServerVariables` of type `map[string]string`.

```golang
```go
ctx := context.WithValue(context.Background(), api_beta.ContextServerVariables, map[string]string{
"basePath": "v2",
})
Expand All @@ -62,7 +63,7 @@ Each operation can use different server URL defined using `OperationServers` map
An operation is uniquely identified by `"{classname}Service.{nickname}"` string.
Similar rules for overriding default operation server index and variables applies by using `api_beta.ContextOperationServerIndices` and `api_beta.ContextOperationServerVariables` context maps.

```golang
```go
ctx := context.WithValue(context.Background(), api_beta.ContextOperationServerIndices, map[string]int{
"{classname}Service.{nickname}": 2,
})
Expand Down Expand Up @@ -1386,14 +1387,14 @@ Authentication schemes defined for the API:

Example

```golang
```go
auth := context.WithValue(context.Background(), api_beta.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
```go
import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */
Expand All @@ -1415,14 +1416,14 @@ r, err := client.Service.Operation(auth, args)

Example

```golang
```go
auth := context.WithValue(context.Background(), api_beta.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
```go
import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */
Expand All @@ -1443,14 +1444,14 @@ r, err := client.Service.Operation(auth, args)

Example

```golang
```go
auth := context.WithValue(context.Background(), api_beta.ContextAccessToken, "ACCESSTOKENSTRING")
r, err := client.Service.Operation(auth, args)
```

Or via OAuth2 module to automatically refresh tokens and perform user authentication.

```golang
```go
import "golang.org/x/oauth2"

/* Perform OAuth2 round trip request and obtain a token */
Expand Down
Loading
Loading