Create scenarios for metadata

Author: Hayden Roszell

README.md

@@ -2,7 +2,6 @@
 
 Keyfactor-v1
 - API version: v1
-  - Build date: 2022-11-08T11:48:36.483-07:00[America/Phoenix]
 
 This reference serves to document REST-based methods to manage and integrate with Keyfactor. In addition, an embedded interface allows for the execution of calls against the current Keyfactor API instance.
 

api/openapi.yaml

@@ -2776,6 +2776,15 @@ paths:
           default: "1"
           type: string
         style: simple
+      - description: "Desired format [PFX, PEM]"
+        explode: false
+        in: header
+        name: x-certificateformat
+        required: true
+        schema:
+          default: PEM
+          type: string
+        style: simple
       - description: "Type of the request [XMLHttpRequest, APIClient]"
         explode: false
         in: header

docs/CertificateApi.md

@@ -1144,7 +1144,7 @@ public class Example {
 
 <a name="certificateRecoverCertificateAsync"></a>
 # **certificateRecoverCertificateAsync**
-> ModelsRecoveryResponse certificateRecoverCertificateAsync(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion)
+> ModelsRecoveryResponse certificateRecoverCertificateAsync(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion)
 
 Recovers the persisted certificate associated with the provided query
 
@@ -1171,12 +1171,13 @@ public class Example {
     basicAuth.setPassword("YOUR PASSWORD");
 
     CertificateApi apiInstance = new CertificateApi(defaultClient);
+    String xCertificateformat = "PEM"; // String | Desired format [PFX, PEM]
     String xKeyfactorRequestedWith = "APIClient"; // String | Type of the request [XMLHttpRequest, APIClient]
     ModelsCertificateRecoveryRequest rq = new ModelsCertificateRecoveryRequest(); // ModelsCertificateRecoveryRequest | Query to filter the certificate to be recovered
     Integer collectionId = 56; // Integer | Optional certificate collection identifier used to ensure user access to the certificate
     String xKeyfactorApiVersion = "1"; // String | Desired version of the api, if not provided defaults to v1
     try {
-      ModelsRecoveryResponse result = apiInstance.certificateRecoverCertificateAsync(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion);
+      ModelsRecoveryResponse result = apiInstance.certificateRecoverCertificateAsync(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion);
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling CertificateApi#certificateRecoverCertificateAsync");
@@ -1193,6 +1194,7 @@ public class Example {
 
 | Name | Type | Description  | Notes |
 |------------- | ------------- | ------------- | -------------|
+| **xCertificateformat** | **String**| Desired format [PFX, PEM] | [default to PEM] |
 | **xKeyfactorRequestedWith** | **String**| Type of the request [XMLHttpRequest, APIClient] | [default to APIClient] |
 | **rq** | [**ModelsCertificateRecoveryRequest**](ModelsCertificateRecoveryRequest.md)| Query to filter the certificate to be recovered | |
 | **collectionId** | **Integer**| Optional certificate collection identifier used to ensure user access to the certificate | [optional] |

pom.xml

@@ -24,10 +24,10 @@
 
     <developers>
         <developer>
-            <name>OpenAPI-Generator Contributors</name>
+            <name>Keyfactor</name>
             <email>team@openapitools.org</email>
-            <organization>OpenAPITools.org</organization>
-            <organizationUrl>http://openapitools.org</organizationUrl>
+            <organization>Keyfactor</organization>
+            <organizationUrl>keyfactor.com</organizationUrl>
         </developer>
     </developers>
 

src/main/java/com/keyfactor/command/client/ApiException.java

@@ -22,7 +22,7 @@
  * <p>ApiException class.</p>
  */
 @SuppressWarnings("serial")
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-11-08T11:48:36.483-07:00[America/Phoenix]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class ApiException extends Exception {
     private int code = 0;
     private Map<String, List<String>> responseHeaders = null;

src/main/java/com/keyfactor/command/client/Configuration.java

@@ -13,7 +13,7 @@
 
 package com.keyfactor.command.client;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-11-08T11:48:36.483-07:00[America/Phoenix]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class Configuration {
     private static ApiClient defaultApiClient = new ApiClient();
 

src/main/java/com/keyfactor/command/client/Pair.java

@@ -13,7 +13,7 @@
 
 package com.keyfactor.command.client;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-11-08T11:48:36.483-07:00[America/Phoenix]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class Pair {
     private String name = "";
     private String value = "";

src/main/java/com/keyfactor/command/client/StringUtil.java

@@ -16,7 +16,7 @@
 import java.util.Collection;
 import java.util.Iterator;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-11-08T11:48:36.483-07:00[America/Phoenix]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class StringUtil {
   /**
    * Check if the given array contains the given value (with case-insensitive comparison).

src/main/java/com/keyfactor/command/client/api/CertificateApi.java

@@ -2526,6 +2526,7 @@ public okhttp3.Call certificateQueryCertificatesAsync(String xKeyfactorRequested
     }
     /**
      * Build call for certificateRecoverCertificateAsync
+     * @param xCertificateformat Desired format [PFX, PEM] (required)
      * @param xKeyfactorRequestedWith Type of the request [XMLHttpRequest, APIClient] (required)
      * @param rq Query to filter the certificate to be recovered (required)
      * @param collectionId Optional certificate collection identifier used to ensure user access to the certificate (optional)
@@ -2539,7 +2540,7 @@ public okhttp3.Call certificateQueryCertificatesAsync(String xKeyfactorRequested
         <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call certificateRecoverCertificateAsyncCall(String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback _callback) throws ApiException {
+    public okhttp3.Call certificateRecoverCertificateAsyncCall(String xCertificateformat, String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback _callback) throws ApiException {
         String basePath = null;
         // Operation Servers
         String[] localBasePaths = new String[] {  };
@@ -2572,6 +2573,10 @@ public okhttp3.Call certificateRecoverCertificateAsyncCall(String xKeyfactorRequ
             localVarHeaderParams.put("x-keyfactor-api-version", localVarApiClient.parameterToString(xKeyfactorApiVersion));
         }
 
+        if (xCertificateformat != null) {
+            localVarHeaderParams.put("x-certificateformat", localVarApiClient.parameterToString(xCertificateformat));
+        }
+
         if (xKeyfactorRequestedWith != null) {
             localVarHeaderParams.put("x-keyfactor-requested-with", localVarApiClient.parameterToString(xKeyfactorRequestedWith));
         }
@@ -2597,7 +2602,12 @@ public okhttp3.Call certificateRecoverCertificateAsyncCall(String xKeyfactorRequ
     }
 
     @SuppressWarnings("rawtypes")
-    private okhttp3.Call certificateRecoverCertificateAsyncValidateBeforeCall(String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback _callback) throws ApiException {
+    private okhttp3.Call certificateRecoverCertificateAsyncValidateBeforeCall(String xCertificateformat, String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback _callback) throws ApiException {
+        // verify the required parameter 'xCertificateformat' is set
+        if (xCertificateformat == null) {
+            throw new ApiException("Missing the required parameter 'xCertificateformat' when calling certificateRecoverCertificateAsync(Async)");
+        }
+
         // verify the required parameter 'xKeyfactorRequestedWith' is set
         if (xKeyfactorRequestedWith == null) {
             throw new ApiException("Missing the required parameter 'xKeyfactorRequestedWith' when calling certificateRecoverCertificateAsync(Async)");
@@ -2608,13 +2618,14 @@ private okhttp3.Call certificateRecoverCertificateAsyncValidateBeforeCall(String
             throw new ApiException("Missing the required parameter 'rq' when calling certificateRecoverCertificateAsync(Async)");
         }
 
-        return certificateRecoverCertificateAsyncCall(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, _callback);
+        return certificateRecoverCertificateAsyncCall(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, _callback);
 
     }
 
     /**
      * Recovers the persisted certificate associated with the provided query
      * *NOTE: At least one of the following criteria must be provided:  1. Certificate ID  2. Thumbprint  3. Serial number AND Issuer DN (because Serial Number is CA-specific and so is not unique enough on its own)
+     * @param xCertificateformat Desired format [PFX, PEM] (required)
      * @param xKeyfactorRequestedWith Type of the request [XMLHttpRequest, APIClient] (required)
      * @param rq Query to filter the certificate to be recovered (required)
      * @param collectionId Optional certificate collection identifier used to ensure user access to the certificate (optional)
@@ -2627,14 +2638,15 @@ private okhttp3.Call certificateRecoverCertificateAsyncValidateBeforeCall(String
         <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
      </table>
      */
-    public ModelsRecoveryResponse certificateRecoverCertificateAsync(String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion) throws ApiException {
-        ApiResponse<ModelsRecoveryResponse> localVarResp = certificateRecoverCertificateAsyncWithHttpInfo(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion);
+    public ModelsRecoveryResponse certificateRecoverCertificateAsync(String xCertificateformat, String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion) throws ApiException {
+        ApiResponse<ModelsRecoveryResponse> localVarResp = certificateRecoverCertificateAsyncWithHttpInfo(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion);
         return localVarResp.getData();
     }
 
     /**
      * Recovers the persisted certificate associated with the provided query
      * *NOTE: At least one of the following criteria must be provided:  1. Certificate ID  2. Thumbprint  3. Serial number AND Issuer DN (because Serial Number is CA-specific and so is not unique enough on its own)
+     * @param xCertificateformat Desired format [PFX, PEM] (required)
      * @param xKeyfactorRequestedWith Type of the request [XMLHttpRequest, APIClient] (required)
      * @param rq Query to filter the certificate to be recovered (required)
      * @param collectionId Optional certificate collection identifier used to ensure user access to the certificate (optional)
@@ -2647,15 +2659,16 @@ public ModelsRecoveryResponse certificateRecoverCertificateAsync(String xKeyfact
         <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
      </table>
      */
-    public ApiResponse<ModelsRecoveryResponse> certificateRecoverCertificateAsyncWithHttpInfo(String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion) throws ApiException {
-        okhttp3.Call localVarCall = certificateRecoverCertificateAsyncValidateBeforeCall(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, null);
+    public ApiResponse<ModelsRecoveryResponse> certificateRecoverCertificateAsyncWithHttpInfo(String xCertificateformat, String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion) throws ApiException {
+        okhttp3.Call localVarCall = certificateRecoverCertificateAsyncValidateBeforeCall(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, null);
         Type localVarReturnType = new TypeToken<ModelsRecoveryResponse>(){}.getType();
         return localVarApiClient.execute(localVarCall, localVarReturnType);
     }
 
     /**
      * Recovers the persisted certificate associated with the provided query (asynchronously)
      * *NOTE: At least one of the following criteria must be provided:  1. Certificate ID  2. Thumbprint  3. Serial number AND Issuer DN (because Serial Number is CA-specific and so is not unique enough on its own)
+     * @param xCertificateformat Desired format [PFX, PEM] (required)
      * @param xKeyfactorRequestedWith Type of the request [XMLHttpRequest, APIClient] (required)
      * @param rq Query to filter the certificate to be recovered (required)
      * @param collectionId Optional certificate collection identifier used to ensure user access to the certificate (optional)
@@ -2669,9 +2682,9 @@ public ApiResponse<ModelsRecoveryResponse> certificateRecoverCertificateAsyncWit
         <tr><td> 200 </td><td> OK </td><td>  -  </td></tr>
      </table>
      */
-    public okhttp3.Call certificateRecoverCertificateAsyncAsync(String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback<ModelsRecoveryResponse> _callback) throws ApiException {
+    public okhttp3.Call certificateRecoverCertificateAsyncAsync(String xCertificateformat, String xKeyfactorRequestedWith, ModelsCertificateRecoveryRequest rq, Integer collectionId, String xKeyfactorApiVersion, final ApiCallback<ModelsRecoveryResponse> _callback) throws ApiException {
 
-        okhttp3.Call localVarCall = certificateRecoverCertificateAsyncValidateBeforeCall(xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, _callback);
+        okhttp3.Call localVarCall = certificateRecoverCertificateAsyncValidateBeforeCall(xCertificateformat, xKeyfactorRequestedWith, rq, collectionId, xKeyfactorApiVersion, _callback);
         Type localVarReturnType = new TypeToken<ModelsRecoveryResponse>(){}.getType();
         localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
         return localVarCall;

src/main/java/com/keyfactor/command/client/auth/ApiKeyAuth.java

@@ -20,7 +20,7 @@
 import java.util.Map;
 import java.util.List;
 
-@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2022-11-08T11:48:36.483-07:00[America/Phoenix]")
+@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")
 public class ApiKeyAuth implements Authentication {
   private final String location;
   private final String paramName;