Skip to content

Commit 1ec5908

Browse files
quanb-duyhkad98
authored andcommitted
docs(fix) - replaced all doc md contents (besides examples) with a shortcode used in api ref
JIRA: DP-2970
1 parent 696c677 commit 1ec5908

File tree

117 files changed

+119
-2296
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

117 files changed

+119
-2296
lines changed

docs/content/en/latest/administration/notification-channels/get_declarative_notification_channels.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,7 @@ no_list: true
66
superheading: "catalog_organization."
77
---
88

9-
10-
11-
``get_declarative_notification_channels()``
12-
13-
Get all declarative notification channels in the current organization.
14-
15-
{{% parameters-block title="Parameters" None="yes" %}}
16-
{{% /parameters-block %}}
17-
18-
{{% parameters-block title="Returns" %}}
19-
{{< parameter p_type="list[CatalogDeclarativeNotificationChannel]" >}}
20-
List of declarative notification channels.
21-
{{< /parameter >}}
22-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogOrganizationService.get_declarative_notification_channels" >}}
2310

2411
## Example
2512

docs/content/en/latest/administration/notification-channels/put_declarative_notification_channels.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,7 @@ no_list: true
66
superheading: "catalog_organization."
77
---
88

9-
10-
11-
``put_declarative_notification_channels(notification_channels: list[CatalogDeclarativeNotificationChannel])``
12-
13-
Put declarative notification channels in the current organization.
14-
15-
{{% parameters-block title="Parameters"%}}
16-
{{< parameter p_name="notification_channels" p_type="list[CatalogDeclarativeNotificationChannel]" >}}
17-
List of declarative notification channels.
18-
{{< /parameter >}}
19-
{{% /parameters-block %}}
20-
21-
{{% parameters-block title="Returns" None="yes" %}}
22-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogOrganizationService.put_declarative_notification_channels" >}}
2310

2411
## Example
2512

docs/content/en/latest/administration/organization/create_or_update_jwk.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,4 @@ superheading: "catalog_organization."
55
weight: 100
66
---
77

8-
``create_or_update_jwk( jwk: CatalogJwk ) -> None``
9-
10-
Create a new jwk or overwrite an existing jwk with the same id.
11-
12-
## Parameters
13-
14-
| name | type | description |
15-
| -- | -- | -- |
16-
| jwk | CatalogJwk | Catalog Jwk object to be created or updated. |
17-
18-
## Returns
19-
20-
_None_
8+
{{< api-ref "sdk.CatalogOrganizationService.create_or_update_jwk" >}}

docs/content/en/latest/administration/organization/delete_jwk.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,4 @@ superheading: "catalog_organization."
55
weight: 100
66
---
77

8-
``delete_jwk( jwk_id: str ) -> None``
9-
10-
Delete a jwk.
11-
12-
## Parameters
13-
14-
| name | type | description |
15-
| -- | -- |-----------------------------------------|
16-
| jwk_id | str | Jwk identification string e.g. "demo" |
17-
18-
## Returns
19-
20-
_None_
8+
{{< api-ref "sdk.CatalogOrganizationService.delete_jwk" >}}

docs/content/en/latest/administration/organization/get_jwk.md

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,4 @@ superheading: "catalog_organization."
55
weight: 100
66
---
77

8-
``get_jwk( jwk_id: str ) -> CatalogJwk``
9-
10-
Get an individual jwk.
11-
12-
## Parameters
13-
14-
|name | type| description |
15-
| --- | --- | --- |
16-
| jwk_id | str | Jwk identification string e.g. "demo"|
17-
18-
19-
## Returns
20-
21-
| type | description |
22-
| --- |-----------------------------------------------------|
23-
| CatalogJwk | Catalog jwk object containing structure of the jwk. |
8+
{{< api-ref "sdk.CatalogOrganizationService.get_jwk" >}}

docs/content/en/latest/administration/organization/list_jwks.md

Lines changed: 1 addition & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -5,16 +5,4 @@ superheading: "catalog_organization."
55
weight: 100
66
---
77

8-
``list_jwks( ) -> List[CatalogJwk]``
9-
10-
Returns a list of all jwks in the current organization.
11-
12-
## Parameters
13-
14-
_None_
15-
16-
## Returns
17-
18-
| type | description |
19-
| -- | -- |
20-
| List[CatalogJwk] | List of jwks in the current organization. |
8+
{{< api-ref "sdk.CatalogOrganizationService.list_jwks" >}}

docs/content/en/latest/administration/organization/update_name.md

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,21 +6,7 @@ no_list: true
66
superheading: "catalog_organization."
77
---
88

9-
10-
11-
``update_name(name: str)``
12-
13-
Updates the name of the organization.
14-
15-
{{% parameters-block title="Parameters"%}}
16-
17-
{{< parameter p_name="name" p_type="string" >}}
18-
New name of the organization
19-
{{< /parameter >}}
20-
{{% /parameters-block %}}
21-
22-
{{% parameters-block title="Returns" None="yes"%}}
23-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogOrganizationService.update_name" >}}
2410

2511
## Example
2612

docs/content/en/latest/administration/organization/update_oidc_parameters.md

Lines changed: 1 addition & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,33 +6,7 @@ no_list: true
66
superheading: "catalog_organization."
77
---
88

9-
10-
11-
``update_oidc_parameters(oauth_issuer_location: Optional[str] = None, oauth_client_id: Optional[str] = None, oauth_client_secret: Optional[str] = None)``
12-
13-
Updates the OIDC parameters for a given users.
14-
15-
{{% parameters-block title="Parameters"%}}
16-
17-
{{< parameter p_name="oauth_issuer_location" p_type="Optional[string]" >}}
18-
Issuer location. Defaults to None.
19-
{{< /parameter >}}
20-
{{< parameter p_name="oauth_client_id" p_type="Optional[string]" >}}
21-
Public client identifier. Defaults to None.
22-
{{< /parameter >}}
23-
{{< parameter p_name="oauth_client_secret" p_type="Optional[string]" >}}
24-
Client secret. Defaults to None.
25-
{{< /parameter >}}
26-
{{% /parameters-block %}}
27-
28-
{{% parameters-block title="Returns" None="yes"%}}
29-
{{% /parameters-block %}}
30-
31-
{{% parameters-block title="Raises"%}}
32-
{{< parameter p_name="ValueError" >}}
33-
Parameters were not strictly all none or all string.
34-
{{< /parameter >}}
35-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogOrganizationService.update_oidc_parameters" >}}
3610

3711
## Example
3812

docs/content/en/latest/administration/permissions/get_declarative_organization_permissions.md

Lines changed: 1 addition & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,7 @@ no_list: true
66
superheading: "catalog_permission."
77
---
88

9-
10-
11-
``get_declarative_organization_permissions()``
12-
13-
Gets the current set of permissions of the workspace in a declarative form.
14-
15-
{{% parameters-block title="Parameters" None="yes" %}}
16-
{{% /parameters-block %}}
17-
18-
{{% parameters-block title="Returns"%}}
19-
{{< parameter p_type="List[CatalogDeclarativeOrganizationPermission]" >}}
20-
List of Objects Containing Organization Permissions.
21-
{{< /parameter >}}
22-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogPermissionService.get_declarative_organization_permissions" >}}
2310

2411
## Example
2512

docs/content/en/latest/administration/permissions/get_declarative_permissions.md

Lines changed: 1 addition & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,7 @@ no_list: true
66
superheading: "catalog_permission."
77
---
88

9-
10-
11-
``get_declarative_permissions(workspace_id: str)``
12-
13-
Gets the current set of permissions of the workspace in a declarative form.
14-
15-
{{% parameters-block title="Parameters"%}}
16-
{{< parameter p_name="workspace_id" p_type="string" >}}
17-
Workspace identification string. e.g. "demo"
18-
{{< /parameter >}}
19-
{{% /parameters-block %}}
20-
21-
{{% parameters-block title="Returns"%}}
22-
{{< parameter p_type="CatalogDeclarativeWorkspacePermissions" >}}
23-
Object Containing Workspace Permissions.
24-
{{< /parameter >}}
25-
{{% /parameters-block %}}
9+
{{< api-ref "sdk.CatalogPermissionService.get_declarative_permissions" >}}
2610

2711
## Example
2812

0 commit comments

Comments
 (0)