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

Add support for API Server Deployment #355

Merged
merged 4 commits into from
Jun 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* **Feature** Add support for Application Role Assignments API. [#344](https://github.com/patrickcping/pingone-go-sdk-v2/pull/344)
* **Feature** Add support for Application Role Permissions API. [#344](https://github.com/patrickcping/pingone-go-sdk-v2/pull/344)
* **Feature** Add support for API Server Operations. [#354](https://github.com/patrickcping/pingone-go-sdk-v2/pull/354)
* **Feature** Add support for API Server Deployment.
* **Enhancement** Add the `com.au` top level domain to the connection configuration. [#351](https://github.com/patrickcping/pingone-go-sdk-v2/pull/351)
* **Enhancement** Added `AccessControl` and `Directory` fields to the `APIServer` model. [#353](https://github.com/patrickcping/pingone-go-sdk-v2/pull/353)
* **Enhancement** Added `Type` field to the `APIServerAuthorizationServer` model. [#353](https://github.com/patrickcping/pingone-go-sdk-v2/pull/353)
Expand Down
18 changes: 18 additions & 0 deletions authorize/.openapi-generator/FILES
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
README.md
api/openapi.yaml
api_api_server_deployment.go
api_api_server_operations.go
api_api_servers.go
api_application_resource_permissions.go
Expand All @@ -14,6 +15,15 @@ docs/APIServerAccessControl.md
docs/APIServerAccessControlCustom.md
docs/APIServerAuthorizationServer.md
docs/APIServerAuthorizationServerResource.md
docs/APIServerDeployment.md
docs/APIServerDeploymentAccessControl.md
docs/APIServerDeploymentAccessControlCustom.md
docs/APIServerDeploymentApi.md
docs/APIServerDeploymentAuthorizationVersion.md
docs/APIServerDeploymentDecisionEndpoint.md
docs/APIServerDeploymentPolicy.md
docs/APIServerDeploymentStatus.md
docs/APIServerDeploymentStatusError.md
docs/APIServerDirectory.md
docs/APIServerOperation.md
docs/APIServerOperationAccessControl.md
Expand Down Expand Up @@ -70,6 +80,14 @@ model_api_server_access_control.go
model_api_server_access_control_custom.go
model_api_server_authorization_server.go
model_api_server_authorization_server_resource.go
model_api_server_deployment.go
model_api_server_deployment_access_control.go
model_api_server_deployment_access_control_custom.go
model_api_server_deployment_authorization_version.go
model_api_server_deployment_decision_endpoint.go
model_api_server_deployment_policy.go
model_api_server_deployment_status.go
model_api_server_deployment_status_error.go
model_api_server_directory.go
model_api_server_operation.go
model_api_server_operation_access_control.go
Expand Down
1 change: 1 addition & 0 deletions authorize/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
* **Feature** Add support for Application Role Permissions API. [#344](https://github.com/patrickcping/pingone-go-sdk-v2/pull/344)
* **Feature** Add support for Application Roles API. [#344](https://github.com/patrickcping/pingone-go-sdk-v2/pull/344)
* **Feature** Add support for API Server Operations. [#354](https://github.com/patrickcping/pingone-go-sdk-v2/pull/354)
* **Feature** Add support for API Server Deployment.
* **Enhancement** Add the `com.au` top level domain to the connection configuration. [#351](https://github.com/patrickcping/pingone-go-sdk-v2/pull/351)
* **Enhancement** Added `AccessControl` and `Directory` fields to the `APIServer` model. [#353](https://github.com/patrickcping/pingone-go-sdk-v2/pull/353)
* **Enhancement** Added `Type` field to the `APIServerAuthorizationServer` model. [#353](https://github.com/patrickcping/pingone-go-sdk-v2/pull/353)
Expand Down
10 changes: 10 additions & 0 deletions authorize/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ All URIs are relative to *https://api.pingone.com/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*APIServerDeploymentApi* | [**DeployAPIServer**](docs/APIServerDeploymentApi.md#deployapiserver) | **Post** /environments/{environmentID}/apiServers/{apiServerID}/deployment | Deploy API Server
*APIServerDeploymentApi* | [**ReadDeploymentStatus**](docs/APIServerDeploymentApi.md#readdeploymentstatus) | **Get** /environments/{environmentID}/apiServers/{apiServerID}/deployment | READ API Server Deployment Status
*APIServerOperationsApi* | [**CreateAPIServerOperation**](docs/APIServerOperationsApi.md#createapiserveroperation) | **Post** /environments/{environmentID}/apiServers/{apiServerID}/operations | CREATE API Server Operation
*APIServerOperationsApi* | [**DeleteAPIServerOperation**](docs/APIServerOperationsApi.md#deleteapiserveroperation) | **Delete** /environments/{environmentID}/apiServers/{apiServerID}/operations/{apiServerOperationID} | DELETE API Server Operation
*APIServerOperationsApi* | [**ReadAllAPIServerOperations**](docs/APIServerOperationsApi.md#readallapiserveroperations) | **Get** /environments/{environmentID}/apiServers/{apiServerID}/operations | READ All API Server Operations
Expand Down Expand Up @@ -117,6 +119,14 @@ Class | Method | HTTP request | Description
- [APIServerAccessControlCustom](docs/APIServerAccessControlCustom.md)
- [APIServerAuthorizationServer](docs/APIServerAuthorizationServer.md)
- [APIServerAuthorizationServerResource](docs/APIServerAuthorizationServerResource.md)
- [APIServerDeployment](docs/APIServerDeployment.md)
- [APIServerDeploymentAccessControl](docs/APIServerDeploymentAccessControl.md)
- [APIServerDeploymentAccessControlCustom](docs/APIServerDeploymentAccessControlCustom.md)
- [APIServerDeploymentAuthorizationVersion](docs/APIServerDeploymentAuthorizationVersion.md)
- [APIServerDeploymentDecisionEndpoint](docs/APIServerDeploymentDecisionEndpoint.md)
- [APIServerDeploymentPolicy](docs/APIServerDeploymentPolicy.md)
- [APIServerDeploymentStatus](docs/APIServerDeploymentStatus.md)
- [APIServerDeploymentStatusError](docs/APIServerDeploymentStatusError.md)
- [APIServerDirectory](docs/APIServerDirectory.md)
- [APIServerOperation](docs/APIServerOperation.md)
- [APIServerOperationAccessControl](docs/APIServerOperationAccessControl.md)
Expand Down
295 changes: 295 additions & 0 deletions authorize/api/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -738,6 +738,163 @@ paths:
summary: UPDATE API Server
tags:
- API Servers
/environments/{environmentID}/apiServers/{apiServerID}/deployment:
get:
operationId: readDeploymentStatus
parameters:
- explode: false
in: path
name: environmentID
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: apiServerID
required: true
schema:
type: string
style: simple
responses:
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: "Invalid request received. Malformed JSON, malformed HTTP\
\ request."
"401":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request failed due to authorization issue.
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request failed due to authorization issue.
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Not found.
"409":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Conflict.
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request was rate limited
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Uncaught error occurred. Platform outage
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/APIServerDeployment'
description: Successful response
summary: READ API Server Deployment Status
tags:
- API Server Deployment
post:
operationId: deployAPIServer
parameters:
- explode: false
in: path
name: environmentID
required: true
schema:
type: string
style: simple
- explode: false
in: path
name: apiServerID
required: true
schema:
type: string
style: simple
- explode: false
in: header
name: Content-Type
required: true
schema:
enum:
- application/vnd.pingidentity.apiserver.deploy+json
type: string
style: simple
responses:
"400":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: "Invalid request received. Malformed JSON, malformed HTTP\
\ request."
"401":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request failed due to authorization issue.
"403":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request failed due to authorization issue.
"404":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Not found.
"405":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: "Invalid request received. Malformed JSON, malformed HTTP\
\ request."
"409":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Conflict.
"429":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Request was rate limited
"500":
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
description: Uncaught error occurred. Platform outage
"200":
content:
application/json:
schema:
$ref: '#/components/schemas/APIServerDeployment'
description: Successful response
summary: Deploy API Server
tags:
- API Server Deployment
/environments/{environmentID}/apiServers/{apiServerID}/operations:
get:
operationId: readAllAPIServerOperations
Expand Down Expand Up @@ -2426,6 +2583,49 @@ components:
- baseURLs
- name
type: object
APIServerDeployment:
example:
accessControl:
custom:
enabled: false
_links:
next:
href: https://openapi-generator.tech
self:
href: https://openapi-generator.tech
authorizationVersion:
id: id
decisionEndpoint:
id: id
deployedAt: 2000-01-23T04:56:07.000+00:00
policy:
id: id
status:
code: POLICIES_CREATE_IN_PROGRESS
error:
code: code
id: id
message: message
properties:
_links:
$ref: '#/components/schemas/LinksHATEOAS'
accessControl:
$ref: '#/components/schemas/APIServerDeployment_accessControl'
authorizationVersion:
$ref: '#/components/schemas/APIServerDeployment_authorizationVersion'
decisionEndpoint:
$ref: '#/components/schemas/APIServerDeployment_decisionEndpoint'
deployedAt:
description: The time of most recent successful deployment. Null if the
API service has never been successfully deployed.
format: date-time
readOnly: true
type: string
policy:
$ref: '#/components/schemas/APIServerDeployment_policy'
status:
$ref: '#/components/schemas/APIServerDeployment_status'
type: object
APIServerOperation:
example:
accessControl:
Expand Down Expand Up @@ -3054,6 +3254,101 @@ components:
required:
- id
type: object
APIServerDeployment_accessControl_custom:
description: Defines if the operation will use custom policy rather than the
"Group" or "Scope" `accessControl` requirement.
example:
enabled: false
properties:
enabled:
default: false
description: "If `TRUE`, custom policy will be used for the endpoint. Defaults\
\ to `FALSE`."
type: boolean
type: object
APIServerDeployment_accessControl:
example:
custom:
enabled: false
properties:
custom:
$ref: '#/components/schemas/APIServerDeployment_accessControl_custom'
type: object
APIServerDeployment_authorizationVersion:
example:
id: id
properties:
id:
description: The UUID of the last deployed policy authorization version.
This is present only if custom polcies are enabled and the API service
has been deployed at least once.
type: string
readOnly: true
type: object
APIServerDeployment_decisionEndpoint:
example:
id: id
properties:
id:
description: The UUID of the decision endpoint.
type: string
readOnly: true
type: object
APIServerDeployment_policy:
example:
id: id
properties:
id:
description: The ID of the root policy.
type: string
readOnly: true
type: object
APIServerDeployment_status_error:
description: Error details returned if the last deployment request failed.
example:
code: code
id: id
message: message
properties:
id:
description: A unique identifier for the error.
type: string
code:
description: "A general fault code that identifies the the type of error.\
\ See [Error codes](https://apidocs.pingidentity.com/pingone/platform/v1/api/#error-codes)."
type: string
message:
description: A short human-readable description of the error.
type: string
type: object
APIServerDeployment_status:
example:
code: POLICIES_CREATE_IN_PROGRESS
error:
code: code
id: id
message: message
properties:
code:
description: "The deployment status code.\n- `POLICIES_CREATE_IN_PROGRESS`\t\
The policy bundle for the API service's managed policies is being created.\n\
- `DECISION_ENDPOINT_CREATE_IN_PROGRESS`\tA decision endpoint is being\
\ created for the API service.\n- `DECISION_ENDPOINT_UPDATE_IN_PROGRESS`\t\
The API service's decision endpoint is being updated.\n- `DEPLOYMENT_SUCCESSFUL`\t\
The API service's policies have been successfully deployed.\n- `DEPLOYMENT_FAILED`\t\
HAP-MGMT was unable to deploy the API service's policies.\n- `DEPLOYMENT_UNINITIALIZED`\t\
A deployment has not yet been attempted.\n"
enum:
- POLICIES_CREATE_IN_PROGRESS
- DECISION_ENDPOINT_CREATE_IN_PROGRESS
- DECISION_ENDPOINT_UPDATE_IN_PROGRESS
- DEPLOYMENT_SUCCESSFUL
- DEPLOYMENT_FAILED
- DEPLOYMENT_UNINITIALIZED
type: string
error:
$ref: '#/components/schemas/APIServerDeployment_status_error'
type: object
APIServerOperation_accessControl_group_groups_inner_element:
description: "The ID of the group, wrapped in an object, for future extensibility.\
\ This is a required property if `operations.value.accessControl.group` is\
Expand Down
Loading
Loading