copy JSON files generated by rspec_api_documentation gem

gayle · Nov 14, 2017 · c9096a4 · c9096a4
1 parent d0f88c7
commit c9096a4
Show file tree

Hide file tree

Showing 14 changed files with 807 additions and 0 deletions.
diff --git a/doc/api/application/activate.json b/doc/api/application/activate.json
@@ -0,0 +1,48 @@
+{
+  "resource": "Lob Application",
+  "resource_explanation": "Public API endpoints for creating LOB Application Assets",
+  "http_method": "POST",
+  "route": "api/public/asset/v1/lob_application/activate/:id",
+  "description": "Activate Asset",
+  "explanation": "Activate a Lob Application Asset",
+  "parameters": [
+    {
+      "required": true,
+      "data_type": "STRING(255)",
+      "name": "source_system",
+      "description": "Name of calling system"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(255)",
+      "name": "source_transaction_id",
+      "description": "Transaction ID supplied by calling system"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "api/public/asset/v1/lob_application/activate/14570",
+      "request_body": "{\"request\":{\"data\":{},\"source_system\":\"Marketplace\",\"source_transaction_id\":\"0934875y2394-8569\"}}",
+      "request_headers": {
+        "Authorization": "Basic TzAwMDA5MToxMjM0NTY=",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "Host": "example.org",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\"activated\":true}",
+      "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"508b21dbddabe09471bc1f3e7583ef4b\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=efa6519e56b7d319f8081d5730fd5c3a; domain=.example.org; path=/; HttpOnly","X-Request-Id":"13f9aa4fb8268aa9ad3dd0c5a0b055da","X-Runtime":"0.141479","Content-Length":"18"},
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+}
+  ]
+}
diff --git a/doc/api/application/create.json b/doc/api/application/create.json
@@ -0,0 +1,69 @@
+{
+  "resource": "Lob Application",
+  "resource_explanation": "Public API endpoints for creating LOB Application Assets",
+  "http_method": "POST",
+  "route": "api/public/asset/v1/lob_application",
+  "description": "Create Asset",
+  "explanation": "Create a Lob Application",
+  "parameters": [
+    {
+      "required": true,
+      "data_type": "INTEGER(38)",
+      "scope": "data",
+      "name": "seal_id",
+      "description": "Also know as appquest application id"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(255)",
+      "scope": "data",
+      "name": "environment",
+      "description": "One of prepopulated values in DB"
+    },
+    {
+      "required": false,
+      "data_type": "STRING(255)",
+      "scope": "data",
+      "name": "instance",
+      "description": "Name of the asset instance"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(255)",
+      "name": "source_system",
+      "description": "Name of calling system"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(255)",
+      "name": "source_transaction_id",
+      "description": "Transaction ID supplied by calling system"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "api/public/asset/v1/lob_application",
+      "request_body": "{\"request\":{\"data\":{\"seal_id\":100002,\"environment\":\"Production\",\"instance\":\"Test\"},\"source_system\":\"GAIA Marketplace\",\"source_transaction_id\":\"348t7gp34iu-8347f\"}}",
+      "request_headers": {
+        "Authorization": "Basic TzAwMDExODoxMjM0NTY=",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "Host": "example.org",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\"asset_id\":14571}",
+      "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"626e6bdfbfd35cbb9fa5f53a93957c7b\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=7b6d9fdb93250553316125ef3bef8ec8; domain=.example.org; path=/; HttpOnly","X-Request-Id":"e3d92e63156ba79cae37572142cf6f72","X-Runtime":"0.127212","Content-Length":"18"},
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+}
+  ]
+}
diff --git a/doc/api/certificate/add.json b/doc/api/certificate/add.json
@@ -0,0 +1,93 @@
+{
+  "resource": "Certificate Request",
+  "resource_explanation": "Public API endpoints for requesting actions for certificates",
+  "http_method": "POST",
+  "route": "/api/public/cert/v1/certificate_request",
+  "description": "Add",
+  "explanation": "Create a new Certificate Request",
+  "parameters": [
+    {
+      "required": true,
+      "name": "data",
+      "description": "Container object for request specific parameters"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cert_request_type",
+      "description": "add"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cert_type",
+      "description": "add"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "fid",
+      "description": "Functional ID"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "INTEGER",
+      "name": "licenses",
+      "description": "Number of licenses you are requesting"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "STRING(255)",
+      "name": "csr",
+      "description": "Valid CSR (SHA256 Encrypted)"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cost_center",
+      "description": "Cost Center"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(4000)",
+      "scope": "data",
+      "name": "description",
+      "description": "Description"
+    },
+    {
+      "required": false,
+      "scope": "data",
+      "data_type": "INTEGER(38)",
+      "name": "notify_sealid",
+      "description": "A seal id to send notifications to"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "/api/public/cert/v1/certificate_request",
+      "request_body": "{\"request\":{\"data\":{\"cert_request_type\":\"Add\",\"fid\":\"O000212\",\"licenses\":1,\"cert_type\":\"example\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"cost_center\":\"12345\",\"description\":\"I am a certificate for JPMCHASE.COM\",\"notify_sealid\":24041},\"requested_for\":\"O000209\"}}",
+      "request_headers": {
+        "Authorization": "Basic TzAwMDIwNjoxMjM0NTY=",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "Host": "example.org",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\"request_id\":5952}",
+      "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"89f03a9bd405403f88e0691c64bbfba2\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=e4de5a521d6a78ba8557ec241d24db77; domain=.example.org; path=/; HttpOnly","X-Request-Id":"fab79e97703cb1d257911eee507bddb4","X-Runtime":"0.109330","Content-Length":"19"},
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+}
+  ]
+}
diff --git a/doc/api/certificate/renew.json b/doc/api/certificate/renew.json
@@ -0,0 +1,67 @@
+{
+  "resource": "Certificate Request",
+  "resource_explanation": "Public API endpoints for requesting actions for certificates",
+  "http_method": "POST",
+  "route": "/api/public/cert/v1/certificate_request",
+  "description": "Renew",
+  "explanation": "Creates a Certificate Renew Request",
+  "parameters": [
+    {
+      "required": true,
+      "name": "data",
+      "description": "Container object for request specific parameters"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cert_request_type",
+      "description": "add"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "fid",
+      "description": "Functional ID"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "STRING(255)",
+      "name": "csr",
+      "description": "Valid CSR (SHA256 Encrypted)"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "INTEGER",
+      "name": "serial_number",
+      "description": "The Serial number of the certificate"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "/api/public/cert/v1/certificate_request",
+      "request_body": "{\"request\":{\"data\":{\"fid\":\"O000203\",\"cert_request_type\":\"Renew\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"serial_number\":\"98210dj38290cjas8f3892jc89813981v\"},\"requested_for\":\"O000200\"}}",
+      "request_headers": {
+        "Authorization": "Basic TzAwMDE5NzoxMjM0NTY=",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "Host": "example.org",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\"request_id\":5951}",
+      "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"9136a5e8b55b4ca351667623baf16503\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=b75c0ae592cda268ab2cb075f318847f; domain=.example.org; path=/; HttpOnly","X-Request-Id":"063c538dfb9fbdb1b2ce083b9699e44e","X-Runtime":"0.109530","Content-Length":"19"},
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+}
+  ]
+}
diff --git a/doc/api/certificate/replace.json b/doc/api/certificate/replace.json
@@ -0,0 +1,94 @@
+{
+  "resource": "Certificate Request",
+  "resource_explanation": "Public API endpoints for requesting actions for certificates",
+  "http_method": "POST",
+  "route": "/api/public/cert/v1/certificate_request",
+  "description": "Replace",
+  "explanation": "Creates a Certificate Replace Request",
+  "parameters": [
+    {
+      "required": true,
+      "name": "data",
+      "description": "Container object for request specific parameters"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cert_request_type",
+      "description": "add"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "fid",
+      "description": "Functional ID"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "STRING(255)",
+      "name": "csr",
+      "description": "Valid CSR (SHA256 Encrypted)"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "INTEGER",
+      "name": "serial_number",
+      "description": "The Serial number of the certificate"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "name": "cost_center",
+      "description": "Cost Center"
+    },
+    {
+      "required": true,
+      "scope": "data",
+      "data_type": "INTEGER",
+      "name": "licenses",
+      "description": "Number of licenses you are requesting"
+    },
+    {
+      "required": true,
+      "data_type": "STRING(4000)",
+      "scope": "data",
+      "name": "description",
+      "description": "Description"
+    },
+    {
+      "required": false,
+      "scope": "data",
+      "data_type": "INTEGER(38)",
+      "name": "notify_sealid",
+      "description": "A seal id to send notifications to"
+    }
+  ],
+  "response_fields": [
+
+  ],
+  "requests": [
+    {
+      "request_method": "POST",
+      "request_path": "/api/public/cert/v1/certificate_request",
+      "request_body": "{\"request\":{\"data\":{\"fid\":\"O000194\",\"cert_request_type\":\"Replace\",\"csr\":\"\\u003C\\u003CCSR\\u003E\\u003E\",\"cost_center\":\"cost center\",\"licenses\":\"licenses\",\"description\":\"I am a certificate for JPMCHASE.COM\",\"notify_sealid\":24041,\"serial_number\":\"98210dj38290cjas8f3892jc89813981v\"},\"requested_for\":\"O000191\"}}",
+      "request_headers": {
+        "Authorization": "Basic TzAwMDE4ODoxMjM0NTY=",
+        "Accept": "application/json",
+        "Content-Type": "application/json",
+        "Host": "example.org",
+        "Cookie": ""
+      },
+      "request_query_parameters": {
+      },
+      "request_content_type": "application/json",
+      "response_status": 200,
+      "response_status_text": "OK",
+      "response_body": "{\"code\":100,\"message\":\"Bad Request\",\"errors\":[[[\"Number of Licenses must be a number between 1 and 99\",\"Old Fid must be provided\"]]]}",
+      "response_headers": {"Content-Type":"application/json; charset=utf-8","Access-Control-Allow-Origin":"*","X-UA-Compatible":"IE=Edge,chrome=1","ETag":"\"6deb492107d9de5cadbedffab7dbd657\"","Cache-Control":"max-age=0, private, must-revalidate","Set-Cookie":"_rsam_test=4736bf78074c83a4324f634a564b1a3c; domain=.example.org; path=/; HttpOnly","X-Request-Id":"05f6acdbad6706356093040a00a5b1ce","X-Runtime":"0.089253","Content-Length":"133"},
+      "response_content_type": "application/json; charset=utf-8",
+      "curl": null
+}
+  ]
+}