-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Retract the
agreementmanagement module (#352)
* Retract the agreementmanagement module * changelog * removal of agreement managemnt from config, tests, CI and docs * version uplift
- Loading branch information
1 parent
ee1ba97
commit a02bb96
Showing
27 changed files
with
60 additions
and
934 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -61,7 +61,6 @@ jobs: | |
| matrix: | ||
| module: | ||
| - '.' | ||
| - 'agreementmanagement' | ||
| - 'authorize' | ||
| - 'credentials' | ||
| - 'management' | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1 @@ | ||
| 0.3.1 | ||
| 0.3.2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,126 +1,6 @@ | ||
| | | This module contains major loss of function and has been retracted. | ||
| |---|---| | ||
|
|
||
| # Go API client for agreementmanagement | ||
|
|
||
| The PingOne Platform API covering the PingOne Agreement Management service | ||
|
|
||
| ## Overview | ||
| 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: 2023-06-29 | ||
| - Package version: 0.3.1 | ||
| - Build package: org.openapitools.codegen.languages.GoClientCodegen | ||
|
|
||
| ## Installation | ||
|
|
||
| Install the following dependencies: | ||
|
|
||
| ```shell | ||
| go get github.com/stretchr/testify/assert | ||
| go get golang.org/x/net/context | ||
| ``` | ||
|
|
||
| Put the package under your project folder and add the following in import: | ||
|
|
||
| ```golang | ||
| import agreementmanagement "github.com/patrickcping/pingone-go-sdk-v2/agreementmanagement" | ||
| ``` | ||
|
|
||
| To use a proxy, set the environment variable `HTTP_PROXY`: | ||
|
|
||
| ```golang | ||
| os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port") | ||
| ``` | ||
|
|
||
| ## Configuration of Server URL | ||
|
|
||
| Default configuration comes with `Servers` field that contains server objects as defined in the OpenAPI specification. | ||
|
|
||
| ### Select Server Configuration | ||
|
|
||
| For using other server than the one defined on index 0 set context value `sw.ContextServerIndex` of type `int`. | ||
|
|
||
| ```golang | ||
| ctx := context.WithValue(context.Background(), agreementmanagement.ContextServerIndex, 1) | ||
| ``` | ||
|
|
||
| ### Templated Server URL | ||
|
|
||
| Templated server URL is formatted using default variables from configuration or from context value `sw.ContextServerVariables` of type `map[string]string`. | ||
|
|
||
| ```golang | ||
| ctx := context.WithValue(context.Background(), agreementmanagement.ContextServerVariables, map[string]string{ | ||
| "basePath": "v2", | ||
| }) | ||
| ``` | ||
|
|
||
| Note, enum values are always validated and all unused variables are silently ignored. | ||
|
|
||
| ### URLs Configuration per Operation | ||
|
|
||
| Each operation can use different server URL defined using `OperationServers` map in the `Configuration`. | ||
| An operation is uniquely identified by `"{classname}Service.{nickname}"` string. | ||
| Similar rules for overriding default operation server index and variables applies by using `sw.ContextOperationServerIndices` and `sw.ContextOperationServerVariables` context maps. | ||
|
|
||
| ```golang | ||
| ctx := context.WithValue(context.Background(), agreementmanagement.ContextOperationServerIndices, map[string]int{ | ||
| "{classname}Service.{nickname}": 2, | ||
| }) | ||
| ctx = context.WithValue(context.Background(), agreementmanagement.ContextOperationServerVariables, map[string]map[string]string{ | ||
| "{classname}Service.{nickname}": { | ||
| "port": "8443", | ||
| }, | ||
| }) | ||
| ``` | ||
|
|
||
| ## Documentation for API Endpoints | ||
|
|
||
| All URIs are relative to *https://agreement-mgmt.pingone.com* | ||
|
|
||
| Class | Method | HTTP request | Description | ||
| ------------ | ------------- | ------------- | ------------- | ||
| *AgreementRevisionsResourcesApi* | [**ReadOneAgreementLanguageRevision**](docs/AgreementRevisionsResourcesApi.md#readoneagreementlanguagerevision) | **Get** /environments/{environmentID}/agreements/{agreementID}/languages/{languageID}/revisions/{revisionID}.json | READ One Agreement Language Revision | ||
|
|
||
|
|
||
| ## Documentation For Models | ||
|
|
||
| - [AgreementRevisionText](docs/AgreementRevisionText.md) | ||
| - [P1Error](docs/P1Error.md) | ||
| - [P1ErrorDetailsInner](docs/P1ErrorDetailsInner.md) | ||
| - [P1ErrorDetailsInnerInnerError](docs/P1ErrorDetailsInnerInnerError.md) | ||
|
|
||
|
|
||
| ## Documentation For Authorization | ||
|
|
||
|
|
||
| Authentication schemes defined for the API: | ||
| ### bearer | ||
|
|
||
| - **Type**: HTTP Bearer token authentication | ||
|
|
||
| Example | ||
|
|
||
| ```golang | ||
| auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING") | ||
| r, err := client.Service.Operation(auth, args) | ||
| ``` | ||
|
|
||
|
|
||
| ## Documentation for Utility Methods | ||
|
|
||
| Due to the fact that model structure members are all pointers, this package contains | ||
| a number of utility functions to easily obtain pointers to values of basic types. | ||
| Each of these functions takes a value of the given basic type and returns a pointer to it: | ||
|
|
||
| * `PtrBool` | ||
| * `PtrInt` | ||
| * `PtrInt32` | ||
| * `PtrInt64` | ||
| * `PtrFloat` | ||
| * `PtrFloat32` | ||
| * `PtrFloat64` | ||
| * `PtrString` | ||
| * `PtrTime` | ||
|
|
||
| ## Author | ||
|
|
||
|
|
||
|
|
Oops, something went wrong.