# openapi-java-client

WSO2 API Manager - Governance
- API version: v1.1

This document specifies a **RESTful API** for WSO2 **API Manager** - Governance.


  For more information, please visit [http://wso2.com/products/api-manager/](http://wso2.com/products/api-manager/)

*Automatically generated by the [OpenAPI Generator](https://openapi-generator.tech)*

## Documentation for API Endpoints

All URIs are relative to *https://apis.wso2.com/api/am/governance/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*ArtifactComplianceApi* | [**getComplianceByAPIId**](docs/ArtifactComplianceApi.md#getComplianceByAPIId) | **GET** /artifact-compliance/api/{apiId} | Retrieve compliance details for a specific API
*ArtifactComplianceApi* | [**getComplianceStatusListOfAPIs**](docs/ArtifactComplianceApi.md#getComplianceStatusListOfAPIs) | **GET** /artifact-compliance/api | Retrieves compliance of all API artifacts
*ArtifactComplianceApi* | [**getComplianceSummaryForAPIs**](docs/ArtifactComplianceApi.md#getComplianceSummaryForAPIs) | **GET** /artifact-compliance/api/summary | Retrieves the summary of compliance of all API artifacts
*ArtifactComplianceApi* | [**getRulesetValidationResultsByAPIId**](docs/ArtifactComplianceApi.md#getRulesetValidationResultsByAPIId) | **GET** /artifact-compliance/api/{apiId}/ruleset-validation-results/{rulesetId} | Retrieve ruleset validation results for a specific API
*GovernancePoliciesApi* | [**createGovernancePolicy**](docs/GovernancePoliciesApi.md#createGovernancePolicy) | **POST** /policies | Creates a new governance policy.
*GovernancePoliciesApi* | [**deleteGovernancePolicy**](docs/GovernancePoliciesApi.md#deleteGovernancePolicy) | **DELETE** /policies/{policyId} | Delete a specific governance policy
*GovernancePoliciesApi* | [**getGovernancePolicies**](docs/GovernancePoliciesApi.md#getGovernancePolicies) | **GET** /policies | Retrieves a list of all governance policies.
*GovernancePoliciesApi* | [**getGovernancePolicyById**](docs/GovernancePoliciesApi.md#getGovernancePolicyById) | **GET** /policies/{policyId} | Get a specific governance policy
*GovernancePoliciesApi* | [**updateGovernancePolicyById**](docs/GovernancePoliciesApi.md#updateGovernancePolicyById) | **PUT** /policies/{policyId} | Update a specific governance policy
*PolicyAdherenceApi* | [**getPolicyAdherenceByPolicyId**](docs/PolicyAdherenceApi.md#getPolicyAdherenceByPolicyId) | **GET** /policy-adherence/{policyId} | Retrieve adherence details for a specific policy
*PolicyAdherenceApi* | [**getPolicyAdherenceForAllPolicies**](docs/PolicyAdherenceApi.md#getPolicyAdherenceForAllPolicies) | **GET** /policy-adherence | Retrieve adherence status for all policies
*PolicyAdherenceApi* | [**getPolicyAdherenceSummary**](docs/PolicyAdherenceApi.md#getPolicyAdherenceSummary) | **GET** /policy-adherence/summary | Retrieves the summary of adherence for all policies
*RulesetsApi* | [**createRuleset**](docs/RulesetsApi.md#createRuleset) | **POST** /rulesets | Create a new ruleset.
*RulesetsApi* | [**deleteRuleset**](docs/RulesetsApi.md#deleteRuleset) | **DELETE** /rulesets/{rulesetId} | Deletes a specific ruleset.
*RulesetsApi* | [**getRulesetById**](docs/RulesetsApi.md#getRulesetById) | **GET** /rulesets/{rulesetId} | Retrieves details of a specific ruleset.
*RulesetsApi* | [**getRulesetContent**](docs/RulesetsApi.md#getRulesetContent) | **GET** /rulesets/{rulesetId}/content | Retrieves the content of a specific ruleset.
*RulesetsApi* | [**getRulesetUsage**](docs/RulesetsApi.md#getRulesetUsage) | **GET** /rulesets/{rulesetId}/usage | Retrieves the policy usage of a specific ruleset.
*RulesetsApi* | [**getRulesets**](docs/RulesetsApi.md#getRulesets) | **GET** /rulesets | Retrieves a list of rulesets.
*RulesetsApi* | [**updateRulesetById**](docs/RulesetsApi.md#updateRulesetById) | **PUT** /rulesets/{rulesetId} | Updates a specific ruleset.


## Documentation for Models

 - [APIMGovernancePolicyDTO](docs/APIMGovernancePolicyDTO.md)
 - [APIMGovernancePolicyListDTO](docs/APIMGovernancePolicyListDTO.md)
 - [ActionDTO](docs/ActionDTO.md)
 - [ArtifactComplianceDetailsDTO](docs/ArtifactComplianceDetailsDTO.md)
 - [ArtifactComplianceForPolicyDTO](docs/ArtifactComplianceForPolicyDTO.md)
 - [ArtifactComplianceListDTO](docs/ArtifactComplianceListDTO.md)
 - [ArtifactComplianceStatusDTO](docs/ArtifactComplianceStatusDTO.md)
 - [ArtifactComplianceSummaryDTO](docs/ArtifactComplianceSummaryDTO.md)
 - [ArtifactComplianceSummaryForPolicyDTO](docs/ArtifactComplianceSummaryForPolicyDTO.md)
 - [ArtifactInfoDTO](docs/ArtifactInfoDTO.md)
 - [ErrorDTO](docs/ErrorDTO.md)
 - [PaginationDTO](docs/PaginationDTO.md)
 - [PolicyAdherenceDetailsDTO](docs/PolicyAdherenceDetailsDTO.md)
 - [PolicyAdherenceListDTO](docs/PolicyAdherenceListDTO.md)
 - [PolicyAdherenceStatusDTO](docs/PolicyAdherenceStatusDTO.md)
 - [PolicyAdherenceSummaryDTO](docs/PolicyAdherenceSummaryDTO.md)
 - [PolicyAdherenceWithRulesetsDTO](docs/PolicyAdherenceWithRulesetsDTO.md)
 - [RuleValidationResultDTO](docs/RuleValidationResultDTO.md)
 - [RuleValidationResultViolatedPathDTO](docs/RuleValidationResultViolatedPathDTO.md)
 - [RulesetInfoDTO](docs/RulesetInfoDTO.md)
 - [RulesetInputDTO](docs/RulesetInputDTO.md)
 - [RulesetListDTO](docs/RulesetListDTO.md)
 - [RulesetValidationResultDTO](docs/RulesetValidationResultDTO.md)
 - [RulesetValidationResultWithoutRulesDTO](docs/RulesetValidationResultWithoutRulesDTO.md)
 - [SeverityBasedRuleViolationCountDTO](docs/SeverityBasedRuleViolationCountDTO.md)


## Documentation for Authorization

Authentication schemes defined for the API:
### OAuth2Security

- **Type**: OAuth
- **Flow**: password
- **Authorization URL**: 
- **Scopes**: 
  - openid: Authorize access to user details
  - apim:gov_rule_read: Read governance rulesets
  - apim:gov_rule_manage: Manage governance rulesets
  - apim:gov_policy_read: Read governance policies
  - apim:gov_policy_manage: Manage governance policies
  - apim:gov_result_read: Read governance results


## Recommendation

It's recommended to create an instance of `ApiClient` per thread in a multithreaded environment to avoid any potential issues.

## Author

architecture@wso2.com

