Skip to content

Commit d644603

Browse files
spicy-saucespicy-sauce
committed
Add Redis Data Integration API reference documentation and layout
1 parent 1ca97d7 commit d644603

File tree

4 files changed

+107
-22
lines changed

4 files changed

+107
-22
lines changed

‎content/integrate/redis-data-integration/reference/api-reference.md

Lines changed: 3 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,5 @@
11
---
2-
Title: Redis Data Integration API Reference
3-
linkTitle: API Reference
4-
description: REST API reference for Redis Data Integration
5-
weight: 20
6-
alwaysopen: false
7-
categories: ["redis-di"]
8-
aliases:
2+
Title: RDI API Reference
3+
layout: rdiapireference
4+
type: page
95
---
10-
11-
# Redis Data Integration API
12-
13-
This is the REST API reference for Redis Data Integration services.
14-
The API provides endpoints to manage and monitor your Redis Data Integration deployments.
15-
16-
[Open API Documentation]({{< relref "/integrate/redis-data-intrgration/reference/api/api-reference" >}})
17-
18-
## Authentication
19-
20-
When authentication is enabled, you need to obtain a token using the login endpoint before accessing secured endpoints.
21-
22-
## Base URL
23-
24-
All API endpoints are relative to the base URL of your Redis Data Integration API server.

‎content/integrate/redis-data-integration/reference/api.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
---
2+
Title: Redis Data Integration API Reference
3+
linkTitle: API Reference
4+
description: REST API reference for Redis Data Integration
5+
weight: 20
6+
alwaysopen: false
7+
categories: ["redis-di"]
8+
aliases:
9+
---
10+
11+
# Redis Data Integration API
12+
13+
This is the REST API reference for Redis Data Integration services.
14+
The API provides endpoints to manage and monitor your Redis Data Integration deployments.
15+
16+
[Open API Documentation]({{< relref "/integrate/redis-data-intrgration/reference/api-reference" >}})
17+
18+
## Authentication
19+
20+
When authentication is enabled, you need to obtain a token using the login endpoint before accessing secured endpoints.
21+
22+
## Base URL
23+
24+
All API endpoints are relative to the base URL of your Redis Data Integration API server.

‎content/integrate/redis-data-integration/reference/api/openapi.json renamed to ‎content/integrate/redis-data-integration/reference/api/api-refernece/openapi.json

File renamed without changes.

‎layouts/_default/rdiapireference.html

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
<!DOCTYPE html>
2+
<html>
3+
4+
<head>
5+
<title>Redis Data Integration API</title>
6+
{{ partial "scss.html" (dict "path" "scss/style.scss") }}
7+
{{ partial "css.html" (dict "path" "css/index.css") }}
8+
{{ $relref := printf "%s%s" .Site.BaseURL "/operate/rc/api/" }}
9+
<!-- needed for adaptive design -->
10+
<!-- <link rel="preload" href="/public/scss/style.min.65324e4de191c292ee8b6f4f0ebf01320e8c4bc8623b04e9dfad322ebb490b31.css" as="style">
11+
<link href="/public/scss/style.min.65324e4de191c292ee8b6f4f0ebf01320e8c4bc8623b04e9dfad322ebb490b31.css" rel="stylesheet" integrity="">
12+
<link href="/public/css/index.min.35cad491f7cd1663c88f0aa4b04c538f4c9f06265fa37217818ca53f59fed259.css" rel="stylesheet" /> -->
13+
<meta charset="utf-8" />
14+
<meta name="viewport" content="width=device-width, initial-scale=1">
15+
<link href="https://fonts.googleapis.com/css?family=Montserrat:300,400,700|Roboto:300,400,700" rel="stylesheet">
16+
<header id="apiReferenceHeader"
17+
class="sticky top-0 z-50 w-full border-b border-redis-pen-300 bg-white text-midnight-900 font-mono text-[15px] flex justify-center">
18+
<div class="flex h-[70px] px-4 lg:pl-11 lg:pr-0 items-center self-center grow">
19+
<a class="relative text-redis-red-500 w-[82px] -mt-[5px] mr-[4px]" href="https://redis.io/">
20+
<svg width="100%" height="100%" viewBox="0 0 85 27" fill="none" xmlns="http://www.w3.org/2000/svg">
21+
<g clip-path="url(#clip0_8_219)">
22+
<path fill-rule="evenodd" clip-rule="evenodd"
23+
d="M75.2909 13.8125C75.2909 10.8448 77.4892 9.12284 80.2371 9.12284C82.2888 9.12284 84.1207 10.1121 85 12.5668C84.7435 13.8125 83.2047 15.2047 82.5453 15.4246C81.9957 14.2522 81.3728 13.556 80.7866 13.556C80.0539 13.556 80.0172 14.069 80.0172 14.7284C80.0172 15.1955 80.151 15.8834 80.3119 16.7112C80.5549 17.9615 80.8599 19.5309 80.8599 21.1401C80.8599 24.0711 78.8082 26.2328 75.6573 26.2328C72.7721 26.2328 71.1778 24.3414 70.4665 21.3198C68.5818 24.6972 65.8257 26.2328 63.7134 26.2328C60.411 26.2328 59.6338 23.7919 59.7121 21.3161C58.3852 23.6612 55.831 26.2328 53.3815 26.2328C50.8809 26.2328 49.9976 24.0563 50.2002 21.5215C48.702 24.3122 45.9919 26.2328 43.3793 26.2328C40.5442 26.2328 39.141 23.9806 39.5951 21.189C37.6878 23.5333 34.1374 26.2328 30.4461 26.2328C26.2373 26.2328 24.4053 23.9632 24.1882 21.1193C22.1568 24.375 19.4187 26.3427 16.1573 26.3427C11.4493 26.3427 9.76537 22.1561 9.52032 18.7315C7.77547 21.0681 5.81377 23.4923 3.40733 26.1961C3.15086 26.4526 2.93103 26.5991 2.67457 26.5991C1.8319 26.5991 0.109914 22.8621 0 21.4698C0.723099 20.3478 5.28119 15.3398 8.95093 11.3079C10.2409 9.89066 11.4211 8.594 12.2863 7.6291C10.0389 8.30726 7.72169 9.65975 4.79957 11.7608C4.28664 12.1272 2.85776 8.7931 2.8944 6.22845C6.26509 3.73707 11.3944 2.16164 15.5345 2.16164C21.3233 2.16164 24.6573 5.38578 24.6573 9.8556C24.6573 13.5927 21.5431 17.6961 17 17.8427C14.6377 17.904 13.1237 16.578 12.3494 14.9405C12.4419 17.473 13.7587 20.5905 17.2931 20.5905C21.1462 20.5905 22.9965 18.2646 25.7559 14.7958C25.9352 14.5704 26.1183 14.3403 26.306 14.1056C28.6509 11.2112 31.3621 8.64655 35.319 8.64655C37.7371 8.64655 39.3858 10.1487 39.3858 12.4203C39.3858 15.1681 36.1616 18.9784 31.6552 18.9784C30.8855 18.9784 30.1839 18.877 29.5917 18.6766C29.5768 18.7921 29.5668 18.9058 29.5668 19.0151C29.5668 20.2974 30.0431 21.0668 32.1315 21.0668C35.2091 21.0668 38.1034 19.2349 41.6207 14.9483C45.0647 10.7349 47.6659 8.90302 50.4138 8.90302C52.2687 8.90302 53.6765 9.90832 54.2969 11.6014C57.9796 6.28253 61.1038 2.51388 63.75 0C66.3513 1.09914 68.2198 3.26078 67.7069 3.70043C65.7651 5.45905 59.2802 12.5302 56.7155 16.7435C56.056 17.8427 55.4332 19.0517 55.4332 19.6379C55.4332 20.1875 55.7629 20.3707 56.1293 20.3707C57.8898 20.3707 61.4176 16.2147 64.4645 12.6253C65.6026 11.2845 66.6736 10.0228 67.5603 9.08621C69.6121 9.92888 71.7004 11.7241 71.1875 12.347C68.4763 15.5711 66.4246 18.2091 66.4246 19.7112C66.4246 20.1142 66.5711 20.3707 67.1207 20.3707C68.1466 20.3707 69.0991 19.4547 70.6746 17.5129C71.0043 17.1099 71.4073 17.1099 71.6638 17.7328C72.3599 19.4181 73.3858 20.3341 74.1918 20.3341C75.1444 20.3341 75.6207 19.4914 75.6207 18.2091C75.6207 17.3327 75.5137 16.3138 75.4217 15.4365C75.3521 14.7733 75.2909 14.191 75.2909 13.8125ZM16.194 13.3362C18.1358 13.3362 20.2608 12.2737 20.2608 10.1121C20.2608 8.80024 19.4466 7.59084 17.2708 7.22257C17.156 7.40192 17.042 7.58017 16.9287 7.75739C15.8231 9.4858 14.7804 11.116 13.7281 12.7095C14.3586 13.0636 15.156 13.3362 16.194 13.3362ZM35.8319 13.9957C35.8319 13.4095 35.4655 13.0065 34.8793 13.0065C33.4094 13.0065 31.1923 15.0693 30.149 17.0613C30.5341 17.2101 30.9862 17.2931 31.472 17.2931C34.0733 17.2931 35.8319 15.3147 35.8319 13.9957ZM45.4677 19.3082C45.4677 19.9677 45.834 20.4073 46.6034 20.4073C48.9849 20.4073 51.9526 16.0841 51.9526 14.3254C51.9526 13.5927 51.5496 13.153 50.8901 13.153C48.7285 13.153 45.4677 17.2565 45.4677 19.3082ZM76.0599 6.08207C75.2172 7.47431 73.9349 9.04974 73.4586 9.52603C71.2603 8.61008 69.2086 6.77819 69.5017 6.26525C70.3077 4.83638 71.6267 3.29758 72.103 2.82129C74.3012 3.73724 76.353 5.60577 76.0599 6.08207Z"
24+
fill="currentColor" />
25+
</g>
26+
<defs>
27+
<clipPath id="clip0_8_219">
28+
<rect width="85" height="26.5991" fill="white" />
29+
</clipPath>
30+
</defs>
31+
</svg>
32+
</a>
33+
<div class="h-full flex items-center mx-4 grow">
34+
<div class="hidden lg:flex flex-row h-full items-center">
35+
<div class="group h-full px-2 xl:px-[14px]">
36+
<div class="flex flex-row h-full items-center cursor-pointer w-[10ch] justify-between">
37+
<a class="relative inline-block group-hover:font-bold" style="white-space: nowrap;" href="{{ $relref }}">Back to
38+
docs</a>
39+
</div>
40+
</div>
41+
</div>
42+
</div>
43+
</div>
44+
</div>
45+
</header>
46+
<!--
47+
Redoc doesn't change outer page styles
48+
-->
49+
<style>
50+
body {
51+
margin: 0;
52+
padding: 0;
53+
display: inherit;
54+
}
55+
56+
:root {
57+
--header-height: 0;
58+
}
59+
</style>
60+
</head>
61+
62+
<body>
63+
<div>
64+
<redoc
65+
spec-url='./openapi.json'
66+
scroll-y-offset='#apiReferenceHeader'
67+
json-sample-expand-level=all
68+
sort-operations-alphabetically="true"
69+
theme='{
70+
"rightPanel": {
71+
"width": "50%"
72+
}
73+
}'
74+
>
75+
</redoc>
76+
<script src="https://cdn.redoc.ly/redoc/latest/bundles/redoc.standalone.js"> </script>
77+
</div>
78+
</body>
79+
80+
</html>

0 commit comments

Comments
 (0)