yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-08-19 14:37:52 +00:00
Code Issues Packages Projects Releases Wiki Activity

added sample content for the api and sdk pages. (#14543)

Browse Source
This commit is contained in:
Aniket Katkar 2024-01-04 21:26:56 +05:30 committed by GitHub
parent 8a1c75b7e9
commit 4b1befacaf
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 374 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

187
openmetadata-docs/content/v1.3.x-SNAPSHOT/api/java-sdk.md Normal file
View File

@ -0,0 +1,187 @@
---
title: Java SDK
slug: /java-sdk
---
{% apiPageContainer %}
{% apiInfoContainer %}
{% apiDescription %}
## Title 1
Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!
{% /apiDescription %}
{% apiVisualInfo %}
### Title in visual info
Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
{% codeWithLanguageSelector title="The Title" id="container-1" languagesArray=["json","python","java","bash"] %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% apiInfoContainer %}
{% apiDescription %}
### SubTitle
API description 2
{% /apiDescription %}
{% apiVisualInfo %}
{% codeWithLanguageSelector title="The Title" id="container-2" languagesArray=["json","python","java","bash"] theme="light" %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" theme="light" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% apiInfoContainer %}
{% apiDescription %}
## Title 2
API description 2
{% /apiDescription %}
{% apiVisualInfo %}
{% codeWithLanguageSelector title="The Title" id="container-3" languagesArray=["json","python","java","bash"] theme="gray" %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" theme="gray" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% /apiPageContainer %}

187
openmetadata-docs/content/v1.3.x-SNAPSHOT/api/python-sdk.md Normal file
View File

@ -0,0 +1,187 @@
---
title: Python SDK
slug: /python-sdk
---
{% apiPageContainer %}
{% apiInfoContainer %}
{% apiDescription %}
## Title 1
Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non
magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate! Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
obcaecati consectetur in exercitationem totam laborum ad voluptate!
{% /apiDescription %}
{% apiVisualInfo %}
### Title in visual info
Lorem ipsum dolor sit amet consectetur, adipisicing elit. Sapiente, non magni provident sit nobis nesciunt labore explicabo ex ipsum unde ab error
{% codeWithLanguageSelector title="The Title" id="container-1" languagesArray=["json","python","java","bash"] %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% apiInfoContainer %}
{% apiDescription %}
### SubTitle
API description 2
{% /apiDescription %}
{% apiVisualInfo %}
{% codeWithLanguageSelector title="The Title" id="container-2" languagesArray=["json","python","java","bash"] theme="light" %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" theme="light" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% apiInfoContainer %}
{% apiDescription %}
## Title 2
API description 2
{% /apiDescription %}
{% apiVisualInfo %}
{% codeWithLanguageSelector title="The Title" id="container-3" languagesArray=["json","python","java","bash"] theme="gray" %}
```json
{
"a": {
"c": "open",
"num": 5,
"val": false
}
}
```
```python
def my_function():
print("Hello world!")
```
```java
public class Main {
static void myMethod() {
System.out.print("Hello world!")
}
}
```
```bash
curl -XPOST <PIPELINE_SERVICE_CLIENT_ENDPOINT>/api/v1/openmetadata/enable --data-raw '{"dag_id": "<DAG name>"}' -u "<user>:<password>" --header 'Content-Type: application/json'
```
{% /codeWithLanguageSelector %}
{% codeBlock fileName="open.json" theme="gray" %}
```
This is a new code
```
{% /codeBlock %}
{% /apiVisualInfo %}
{% /apiInfoContainer %}
{% /apiPageContainer %}