Skip to content

Commit 7bef828

Browse files
unatasha8unatasha8
committed
docs: reorg references
1 parent 1f13ed7 commit 7bef828

11 files changed

Lines changed: 169 additions & 71 deletions

File tree

‎docs/guides/cli/15_config-identity-service.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
id: identity-cli
3-
title: Ory Identities CLI
3+
title: Configure Identities
44
---
55

66
Using the Ory CLI, you can quickly adjust the configuration of the Ory Identities and apply config from the Ory Network

‎docs/hydra/reference/api.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: api
33
hide_title: true
44
title: HTTP API documentation
55
description: Ory Hydra HTTP API documentation
6-
sidebar_label: HTTP API
6+
sidebar_label: REST API
77
---
88

99
```mdx-code-block

‎docs/keto/reference/rest-api.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: rest-api
33
hide_title: true
44
title: HTTP API documentation
55
description: Ory Keto HTTP API documentation
6-
sidebar_label: HTTP API
6+
sidebar_label: REST API
77
---
88

99
```mdx-code-block

‎docs/kratos/reference/api.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
---
22
id: api
33
hide_title: true
4-
title: HTTP API documentation
5-
description: Ory Kratos HTTP API documentation
6-
sidebar_label: HTTP API
4+
title: REST API documentation
5+
description: Ory Kratos REST API documentation
6+
sidebar_label: REST API
77
---
88

99
```mdx-code-block

‎docs/oathkeeper/reference/api.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ id: api
33
hide_title: true
44
title: HTTP API documentation
55
description: Ory Oathkeeper HTTP API documentation
6-
sidebar_label: HTTP API
6+
sidebar_label: REST API
77
---
88

99
```mdx-code-block

‎docs/reference/overview.mdx‎

Lines changed: 113 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,16 @@ sidebar_label: Overview
66
---
77

88
import Link from "@docusaurus/Link"
9+
import Tabs from "@theme/Tabs"
10+
import TabItem from "@theme/TabItem"
11+
12+
<Tabs>
13+
<TabItem value="network" label="Ory Network" default>
14+
15+
# Ory Network
16+
17+
These tools are intended for Ory Network integrations only. You must use the service-specific tools for Ory OEL or Ory OSS
18+
integrations.
919

1020
## Ory CLI
1121

@@ -25,27 +35,120 @@ are available for supported languages.
2535

2636
## Ory SDKs
2737

28-
Ory provides two SDK families depending on your deployment. The Ory Network SDK is a single, unified client that covers identity
29-
management, OAuth2, and permissions in one package. Service-specific SDKs are available for self-hosted deployments, with a
30-
separate client for each Ory product.
31-
32-
### Ory Network SDK
33-
3438
A unified client (ory_client) for integrating with Ory Network. It covers identities, OAuth2, and permissions in a single package,
3539
targeting your project's API at `https://{project_slug}.projects.oryapis.com/`. Available in multiple languages. Consult the REST
3640
API documentation for code samples and usage examples.
3741

3842
[Learn more...](/sdk)
3943

40-
### Service‑specific SDKs for self‑hosted deployments
44+
</TabItem>
45+
46+
<TabItem value="oel" label="Ory OEL" default>
47+
48+
# Ory Enterprise License
49+
50+
These tools are intended for self-hosted deployments only. You must use the unified Ory Network tools for Ory Network
51+
integrations.
52+
53+
## Ory CLI
54+
55+
Service-specific CLIs are available for self-hosted deployments, with a separate client for product.
56+
57+
The CLI is the primary interface for managing Ory OEL from the command line. Use it to create and configure projects, manage
58+
identities and permissions, run local development environments with built-in tunneling, and move configurations between
59+
self-hosted and Ory Network deployments.
60+
61+
Each CLI is documented under its respective product reference.
62+
63+
- [Ory Kratos](/kratos/cli/kratos-cleanup-sql)
64+
- [Ory Hydra](/hydra/cli/hydra-create-client)
65+
- [Ory Keto](/keto/cli/keto-check)
66+
- [Ory Oathkeeper](/oathkeeper/cli/oathkeeper-credentials-generate)
67+
- [Ory Talos](/talos/reference/cli/talos)
68+
69+
## Rest APIs
70+
71+
Service-specific REST APIs are available for self-hosted deployments, with a separate client for each Ory product.
72+
73+
Ory's REST APIs let you manage identities, OAuth2 clients, permissions, and project configuration programmatically. Public APIs
74+
handle end-user flows like authentication. Administrative APIs require a Personal Access Token and cover backend operations. SDKs
75+
are available for supported languages.
76+
77+
Each product's REST API is documented under its respective product reference.
78+
79+
- [Ory Kratos](/kratos/reference/api)
80+
- [Ory Hydra](/hydra/reference/api)
81+
- [Ory Keto](/keto/reference/rest-api)
82+
- [Ory Polis](/polis/reference/api)
83+
- [Ory OathKeeper](/oathkeeper/reference/api)
84+
- [Ory Talos](/talos/reference/api/ory-talos-api)
85+
86+
## SDKs
87+
88+
Service-specific SDKs are available for self-hosted deployments, with a separate client for each Ory product.
89+
90+
- [Ory Kratos](/kratos/sdk/overview)
91+
- [Ory Hydra](/hydra/sdk/overview)
92+
- [Ory Keto](/keto/sdk/overview)
93+
- [Ory Polis](/polis/reference/api)
94+
- [Ory Oathkeeper](/oathkeeper/sdk)
95+
96+
Each SDK is documented under its respective product reference.
97+
98+
</TabItem>
99+
100+
<TabItem value="oss" label="Ory OSS" default>
101+
102+
# Ory Open Source
103+
104+
These tools are intended for self-hosted deployments only. You must use the unified Ory Network tools for Ory Network
105+
integrations.
106+
107+
## Ory CLI
108+
109+
Service-specific CLIs are available for self-hosted deployments, with a separate client for product.
110+
111+
The CLI is the primary interface for managing Ory OEL from the command line. Use it to create and configure projects, manage
112+
identities and permissions, run local development environments with built-in tunneling, and move configurations between
113+
self-hosted and Ory Network deployments.
114+
115+
Each CLI is documented under its respective product reference.
116+
117+
- [Ory Kratos](/kratos/cli/kratos-cleanup-sql)
118+
- [Ory Hydra](/hydra/cli/hydra-create-client)
119+
- [Ory Keto](/keto/cli/keto-check)
120+
- [Ory Oathkeeper](/oathkeeper/cli/oathkeeper-credentials-generate)
121+
- [Ory Talos](/talos/reference/cli/talos)
122+
123+
## Rest APIs
124+
125+
Service-specific REST APIs are available for self-hosted deployments, with a separate client for each Ory product.
41126

42-
Each SDK is documented under its respective product reference. These are intended for self-hosted deployments only. You must use
43-
the unified Ory Network SDK for Ory Network integrations.
127+
Ory's REST APIs let you manage identities, OAuth2 clients, permissions, and project configuration programmatically. Public APIs
128+
handle end-user flows like authentication. Administrative APIs require a Personal Access Token and cover backend operations. SDKs
129+
are available for supported languages.
44130

45-
Separate clients for each self-hosted Ory product:
131+
Each product's REST API is documented under its respective product reference.
132+
133+
- [Ory Kratos](/kratos/reference/api)
134+
- [Ory Hydra](/hydra/reference/api)
135+
- [Ory Keto](/keto/reference/rest-api)
136+
- [Ory Polis](/polis/reference/api)
137+
- [Ory OathKeeper](/oathkeeper/reference/api)
138+
- [Ory Talos](/talos/reference/api/ory-talos-api)
139+
140+
## SDKs
141+
142+
Service-specific SDKs are available for self-hosted deployments, with a separate client for each Ory product.
46143

47144
- [Ory Kratos](/kratos/sdk/overview)
48145
- [Ory Hydra](/hydra/sdk/overview)
49146
- [Ory Keto](/keto/sdk/overview)
50147
- [Ory Polis](/polis/reference/api)
51148
- [Ory Oathkeeper](/oathkeeper/sdk)
149+
150+
Each SDK is documented under its respective product reference.
151+
152+
</TabItem>
153+
154+
</Tabs>

‎sidebars-network.ts‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -827,6 +827,47 @@ const networkSidebar = [
827827
},
828828
],
829829
},
830+
{
831+
type: "category",
832+
label: "Reference",
833+
collapsed: false,
834+
items: [
835+
"reference/api",
836+
"sdk",
837+
{
838+
type: "category",
839+
label: "CLI reference",
840+
collapsed: true,
841+
collapsible: true,
842+
link: {
843+
type: "generated-index",
844+
slug: "/category/ory-cli-reference",
845+
},
846+
items: [
847+
"guides/cli/installation",
848+
"guides/cli/config-with-cli",
849+
"guides/cli/proxy-and-tunnel",
850+
"guides/cli/cli-basics",
851+
"guides/cli/identity-cli",
852+
"guides/cli/oauth2-cli",
853+
"guides/cli/configure-permission-service",
854+
{
855+
type: "category",
856+
label: "CLI commands reference",
857+
link: {
858+
type: "generated-index",
859+
},
860+
items: [
861+
{
862+
type: "autogenerated",
863+
dirName: "cli",
864+
},
865+
],
866+
},
867+
],
868+
},
869+
],
870+
},
830871
],
831872
},
832873
]

‎sidebars-oel.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -139,6 +139,9 @@ const oelSidebar = [
139139
label: "Reference",
140140
items: [
141141
"kratos/reference/api",
142+
{
143+
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
144+
},
142145
{
143146
"Command Line Interface (CLI)": [
144147
{
@@ -147,9 +150,6 @@ const oelSidebar = [
147150
},
148151
],
149152
},
150-
{
151-
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
152-
},
153153
"kratos/reference/configuration",
154154
"kratos/reference/json-schema-json-paths",
155155
"kratos/reference/html-forms",

‎sidebars-oss.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -113,6 +113,9 @@ const ossSidebar = [
113113
label: "Reference",
114114
items: [
115115
"kratos/reference/api",
116+
{
117+
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
118+
},
116119
{
117120
"Command Line Interface (CLI)": [
118121
{
@@ -121,9 +124,6 @@ const ossSidebar = [
121124
},
122125
],
123126
},
124-
{
125-
SDK: ["kratos/sdk/overview", "kratos/self-hosted/go"],
126-
},
127127
"kratos/reference/configuration",
128128
"kratos/reference/json-schema-json-paths",
129129
"kratos/reference/html-forms",

‎sidebars.ts‎

Lines changed: 0 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -23,44 +23,7 @@ import quickstartsSidebar, {
2323
quickstartsOssSidebar,
2424
} from "./sidebars-quickstarts"
2525

26-
const cli: SidebarItemsConfig = [
27-
{
28-
type: "category",
29-
label: "Ory CLI reference",
30-
collapsed: false,
31-
collapsible: false,
32-
link: {
33-
type: "generated-index",
34-
slug: "/category/ory-cli-reference",
35-
},
36-
items: [
37-
"guides/cli/installation",
38-
"guides/cli/cli-basics",
39-
"guides/cli/identity-cli",
40-
"guides/cli/oauth2-cli",
41-
"guides/cli/configure-permission-service",
42-
"guides/cli/proxy-and-tunnel",
43-
"guides/cli/config-with-cli",
44-
{
45-
type: "category",
46-
label: "CLI commands reference",
47-
link: {
48-
type: "generated-index",
49-
},
50-
items: [
51-
{
52-
type: "autogenerated",
53-
dirName: "cli",
54-
},
55-
],
56-
},
57-
],
58-
},
59-
]
60-
6126
const api: SidebarItemsConfig = [
62-
"reference/api",
63-
"ecosystem/api-design",
6427
{
6528
type: "category",
6629
label: "Operations",
@@ -204,7 +167,6 @@ const sidebars: SidebarsConfig = {
204167
quickstartsOelSidebar,
205168
quickstartsOssSidebar,
206169
api,
207-
cli,
208170
troubleshooting,
209171
security,
210172
elements,

0 commit comments

Comments
 (0)