Skip to content

Commit 818679c

Browse files
committed
Removed the word "Depricated" from the title, updated the view of table of contents and notes and updated the links for the authorization.yml file to show up in a page.
1 parent b7ee1fc commit 818679c

File tree

5 files changed

+14
-17
lines changed

5 files changed

+14
-17
lines changed

docs/_includes/authorization.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<div id="swagger-ui-authorization"></div>
1+
<div id="swagger-ui"></div>
22

33
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/5.9.1/swagger-ui.min.css" integrity="sha512-wjyFPe3jl9Y/d+vaEDd04b2+wzgLdgKPVoy9m1FYNpJSMHM328G50WPU57xayVkZwxWi45vA+4QN+9erPZIeig==" crossorigin="anonymous" referrerpolicy="no-referrer" />
44
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/5.9.1/swagger-ui-bundle.min.js" integrity="sha512-ZltHb61aGRLllftCEx5iAhQBNmqa12g2MB9lpmoRl17c4kV5cBvVJ3LiK6nYx98hzHmrV7bE80FPP+IIi08Odw==" crossorigin="anonymous" referrerpolicy="no-referrer"></script>
File renamed without changes.

docs/assets/js/swagger-ui-authorization.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ window.onload = function() {
33
// Begin Swagger UI call region
44
const ui = SwaggerUIBundle({
55
url: "../assets/js/authorization.yml",
6-
dom_id: '#swagger-ui-authorization',
6+
dom_id: '#swagger-ui',
77
deepLinking: true,
88
validatorUrl: null,
99
supportedSubmitMethods: [],

docs/security/RBAC-server-implementation.md

Lines changed: 6 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,12 @@
11
---
2-
title: RBAC Server Implementation -Deprecated-
2+
title: RBAC Server Implementation
33
description: Instructions for implementing an RBAC server to manage permissions in lakeFS OSS.
44
parent: Security
55
---
66

77
# RBAC Server Implementation
88

9-
## Table of Contents
10-
11-
- [Overview](#overview)
12-
- [What is RBAC?](#what-is-rbac)
13-
- [Setting Up the RBAC Server](#setting-up-the-rbac-server)
14-
- [Implementation](#implementation)
15-
- [Credentials APIs](#credentials-apis)
16-
- [Users APIs](#users-apis)
17-
- [Groups APIs](#groups-apis)
18-
- [Policies APIs](#policies-apis)
19-
- [LakeFS Configuration](#configuration)
20-
- [Setup Considerations](#setup-considerations)
21-
- [Running the Server](#running-the-server)
9+
{% include toc_2-4.html %}
2210

2311
## Overview
2412

@@ -30,6 +18,7 @@ Contents:
3018
2. How to configure lakeFS OSS to connect to your RBAC server.
3119
3. How to run lakeFS OSS with your RBAC server.
3220

21+
{: .note}
3322
> For a detailed explanation of the RBAC model in lakeFS, see [RBAC in lakeFS](./rbac.md).
3423
3524
## What is RBAC?
@@ -55,6 +44,7 @@ Not all APIs in the specification are required — only those listed below, grou
5544

5645
Implement all APIs under these categories.
5746

47+
{: .note}
5848
> For detailed descriptions of each API, including their input and output parameters, refer to each API in
5949
> the [authentication.yaml specification](./authorization-yaml.md).
6050
@@ -127,7 +117,8 @@ auth:
127117
token:
128118
```
129119
130-
> **Note:** The `auth.api.token` parameter is optional. If unspecified, lakeFS uses the `auth.encrypt.secret_key` as
120+
{: .note}
121+
> The `auth.api.token` parameter is optional. If unspecified, lakeFS uses the `auth.encrypt.secret_key` as
131122
> the token. If specified, provide a JWT token directly or via the environment variable `LAKEFS_AUTH_API_TOKEN`.
132123

133124
### Setup Considerations

docs/security/authorization-yaml.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,7 @@
1+
---
2+
title: Authorization API
3+
description: This section includes the documentation for the authorization APIs.
4+
parent: Security
5+
---
6+
17
{% include authorization.html %}

0 commit comments

Comments
 (0)