diff --git a/.github/workflows/build_dev.yml b/.github/workflows/build_dev.yml
index 609bf737..03b560ab 100644
--- a/.github/workflows/build_dev.yml
+++ b/.github/workflows/build_dev.yml
@@ -6,18 +6,18 @@ jobs:
build:
runs-on: ubuntu-latest
steps:
- - name: Checkout code
- uses: actions/checkout@v3
- - name: Login to DockerHub
- uses: docker/login-action@v1
- with:
- username: ${{ secrets.DOCKERHUB_USERNAME }}
- password: ${{ secrets.DOCKERHUB_TOKEN }}
- - name: Build and push
- id: docker_build
- uses: docker/build-push-action@v2
- with:
- push: true
- file: "./Dockerfile.dev"
- tags: |
- odpf/compass:dev
+ - name: Checkout code
+ uses: actions/checkout@v3
+ - name: Login to DockerHub
+ uses: docker/login-action@v1
+ with:
+ username: ${{ secrets.DOCKERHUB_USERNAME }}
+ password: ${{ secrets.DOCKERHUB_TOKEN }}
+ - name: Build and push
+ id: docker_build
+ uses: docker/build-push-action@v2
+ with:
+ push: true
+ file: "./Dockerfile.dev"
+ tags: |
+ raystack/compass:dev
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
index 4e769039..d7530f60 100644
--- a/.github/workflows/lint.yml
+++ b/.github/workflows/lint.yml
@@ -8,7 +8,7 @@ jobs:
steps:
- uses: actions/setup-go@v4
with:
- go-version: "1.18"
+ go-version: "1.20"
- uses: actions/checkout@v3
with:
fetch-depth: 0
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index c5a561f5..4bab4db6 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -1,23 +1,22 @@
-name: release
+name: Release
on:
push:
tags:
- - 'v*.*.*'
- workflow_dispatch:
+ - "v*"
jobs:
- release:
+ goreleaser:
runs-on: ubuntu-latest
steps:
- - name: Set up Go
- uses: actions/setup-go@v4
- with:
- go-version: '^1.18'
- - name: Checkout
- uses: actions/checkout@v3
+ - name: Checkout code
+ uses: actions/checkout@v2
with:
fetch-depth: 0
+ - name: Set up Go
+ uses: actions/setup-go@v2
+ with:
+ go-version: "1.20"
- name: Login to DockerHub
uses: docker/login-action@v1
with:
@@ -25,10 +24,10 @@ jobs:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
- name: Run GoReleaser
- uses: goreleaser/goreleaser-action@v2.6.1
+ uses: goreleaser/goreleaser-action@v4
with:
distribution: goreleaser
version: latest
- args: --rm-dist
+ args: release --clean
env:
GITHUB_TOKEN: ${{ secrets.GO_RELEASER_TOKEN }}
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
index 28545681..1ea66931 100644
--- a/.github/workflows/test.yml
+++ b/.github/workflows/test.yml
@@ -10,12 +10,12 @@ jobs:
ports:
- 9200:9200
env:
- ES_TEST_SERVER_URL: 'http://elasticsearch:9200'
+ ES_TEST_SERVER_URL: "http://elasticsearch:9200"
steps:
- uses: actions/checkout@v3
- uses: actions/setup-go@v4
with:
- go-version: 1.18
+ go-version: "1.20"
- name: Install dependencies
run: sudo apt-get install build-essential
- name: Install packages
@@ -28,4 +28,4 @@ jobs:
run: |
go get github.com/mattn/goveralls
go install github.com/mattn/goveralls
- goveralls -coverprofile=coverage.txt -service=github
\ No newline at end of file
+ goveralls -coverprofile=coverage.txt -service=github
diff --git a/.goreleaser.yml b/.goreleaser.yml
index e58b3d8c..881adec4 100644
--- a/.goreleaser.yml
+++ b/.goreleaser.yml
@@ -1,81 +1,75 @@
project_name: compass
+
release:
prerelease: auto
+
before:
hooks:
- go mod tidy
- make clean
+
+changelog:
+ sort: asc
+ filters:
+ exclude:
+ - "^docs:"
+ - "^test:"
+ - "^build:"
+
builds:
- id: compass
main: ./main.go
binary: compass
flags: [-a]
ldflags:
- - -X github.com/odpf/compass/cli.Version={{.Tag}}
- - -X github.com/odpf/compass/cli.BuildCommit={{.FullCommit}}
- - -X github.com/odpf/compass/cli.BuildDate={{.Date}}
+ - -X github.com/raystack/compass/cli.Version={{.Tag}}
+ - -X github.com/raystack/compass/cli.BuildCommit={{.FullCommit}}
+ - -X github.com/raystack/compass/cli.BuildDate={{.Date}}
goos: [linux, darwin, windows]
- goarch: [amd64, 386, arm, arm64] # skip goarch 386 and arm due to conflicts with "github.com/blastrain/vitess-sqlparser" library
+ goarch: [amd64, 386, arm, arm64]
env:
- CGO_ENABLED=0
+
archives:
- - replacements:
- darwin: macos
- linux: linux
- windows: windows
- 386: i386
- amd64: x86_64
+ - id: "archives"
format_overrides:
- goos: windows
format: zip
-checksum:
- name_template: "checksums.txt"
-snapshot:
- name_template: "{{ .Tag }}-next"
-changelog:
- sort: asc
- filters:
- exclude:
- - "^docs:"
- - "^test:"
- - "^build:"
+
dockers:
- - goos: linux
- goarch: amd64
- ids:
- - compass
- dockerfile: Dockerfile
+ - id: dockerhub
image_templates:
- - "docker.io/odpf/{{.ProjectName}}:latest"
- - "docker.io/odpf/{{.ProjectName}}:{{ .Version }}"
- - "docker.io/odpf/{{.ProjectName}}:{{ .Version }}-amd64"
+ - "docker.io/raystack/{{.ProjectName}}:latest"
+ - "docker.io/raystack/{{.ProjectName}}:{{ .Version }}"
+ - "docker.io/raystack/{{.ProjectName}}:{{ .Tag }}-amd64"
+
nfpms:
- - maintainer: ODPF
- description: Metadata Discovery and Lineage Service
- homepage: https://github.com/odpf/compass
+ - maintainer: Raystack
+ description: Data catalog service
+ homepage: https://github.com/raystack/compass
license: Apache 2.0
formats:
- deb
- rpm
- replacements:
- darwin: macOS
-scoop:
- bucket:
- owner: odpf
- name: scoop-bucket
- homepage: "https://github.com/odpf/compass"
- description: "Metadata Discovery and Lineage Service"
- license: Apache 2.0
+ - apk
+
+scoops:
+ - homepage: "https://github.com/raystack/compass"
+ description: "Data catalog service"
+ license: Apache 2.0
+ bucket:
+ owner: raystack
+ name: scoop-bucket
+
brews:
- name: compass
- homepage: "https://github.com/odpf/compass"
- description: "Metadata Discovery and Lineage Service"
+ homepage: "https://github.com/raystack/compass"
+ description: "Data catalog service"
tap:
- owner: odpf
+ owner: raystack
name: homebrew-tap
license: "Apache 2.0"
folder: Formula
-
dependencies:
- name: git
install: |-
diff --git a/Makefile b/Makefile
index 9241736d..023dd3b6 100644
--- a/Makefile
+++ b/Makefile
@@ -1,4 +1,4 @@
-NAME="github.com/odpf/compass"
+NAME="github.com/raystack/compass"
VERSION=$(shell git describe --always --tags 2>/dev/null)
COVERFILE="/tmp/compass.coverprofile"
PROTON_COMMIT := "eeec3f31b21ee7d00b016fcdcd7070606aa33366"
@@ -31,9 +31,9 @@ lint: ## Lint checker
golangci-lint run
proto: ## Generate the protobuf files
- @echo " > generating protobuf from odpf/proton"
+ @echo " > generating protobuf from raystack/proton"
@echo " > [info] make sure correct version of dependencies are installed using 'make install'"
- @buf generate https://github.com/odpf/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --template buf.gen.yaml --path odpf/compass -v
+ @buf generate https://github.com/raystack/proton/archive/${PROTON_COMMIT}.zip#strip_components=1 --template buf.gen.yaml --path raystack/compass -v
@echo " > protobuf compilation finished"
install: ## Install required dependencies
diff --git a/README.md b/README.md
index db5a513a..601dfafd 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
# Compass
-![test workflow](https://github.com/odpf/compass/actions/workflows/test.yml/badge.svg)
-![build workflow](https://github.com/odpf/compass/actions/workflows/build_dev.yml/badge.svg)
-[![Coverage Status](https://coveralls.io/repos/github/odpf/compass/badge.svg?branch=main)](https://coveralls.io/github/odpf/compass?branch=main)
+![test workflow](https://github.com/raystack/compass/actions/workflows/test.yml/badge.svg)
+![build workflow](https://github.com/raystack/compass/actions/workflows/build_dev.yml/badge.svg)
+[![Coverage Status](https://coveralls.io/repos/github/raystack/compass/badge.svg?branch=main)](https://coveralls.io/github/raystack/compass?branch=main)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg?logo=apache)](LICENSE)
-[![Version](https://img.shields.io/github/v/release/odpf/compass?logo=semantic-release)](Version)
+[![Version](https://img.shields.io/github/v/release/raystack/compass?logo=semantic-release)](Version)
Compass is a search and discovery engine built for querying application deployments, datasets and meta resources. It can also optionally track data flow relationships between these resources and allow the user to view a representation of the data flow graph.
@@ -25,27 +25,27 @@ Discover why users choose Compass as their main data discovery and lineage servi
Explore the following resources to get started with Compass:
-- [Guides](https://odpf.github.io/compass/docs/guides) provides guidance on ingesting and querying metadata from Compass.
-- [Concepts](https://odpf.github.io/compass/docs/concepts) describes all important Compass concepts.
-- [Reference](https://odpf.github.io/compass/docs/reference) contains details about configurations, metrics and other aspects of Compass.
-- [Contribute](https://odpf.github.io/compass/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.
+- [Guides](https://raystack.github.io/compass/docs/guides) provides guidance on ingesting and querying metadata from Compass.
+- [Concepts](https://raystack.github.io/compass/docs/concepts) describes all important Compass concepts.
+- [Reference](https://raystack.github.io/compass/docs/reference) contains details about configurations, metrics and other aspects of Compass.
+- [Contribute](https://raystack.github.io/compass/docs/contribute/contribution.md) contains resources for anyone who wants to contribute to Compass.
## Installation
-Install Compass on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. Refer this for [installations](https://odpf.github.io/compass/docs/installation) and [configurations](https://odpf.github.io/compass/docs/guides/configuration)
+Install Compass on macOS, Windows, Linux, OpenBSD, FreeBSD, and on any machine. Refer this for [installations](https://raystack.github.io/compass/docs/installation) and [configurations](https://raystack.github.io/compass/docs/guides/configuration)
#### Binary (Cross-platform)
-Download the appropriate version for your platform from [releases](https://github.com/odpf/compass/releases) page. Once downloaded, the binary can be run from anywhere.
+Download the appropriate version for your platform from [releases](https://github.com/raystack/compass/releases) page. Once downloaded, the binary can be run from anywhere.
You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.
Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
#### macOS
-`compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/compass/releases/latest) page:
+`compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:
```sh
-brew install odpf/tap/compass
+brew install raystack/tap/compass
```
To upgrade to the latest version:
@@ -62,14 +62,14 @@ compass version
#### Linux
-`compass` is available as downloadable binaries from the [releases](https://github.com/odpf/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
+`compass` is available as downloadable binaries from the [releases](https://github.com/raystack/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
#### Windows
-`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/compass/releases/latest) page:
+`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:
```
-scoop bucket add compass https://github.com/odpf/scoop-bucket.git
+scoop bucket add compass https://github.com/raystack/scoop-bucket.git
```
To upgrade to the latest version:
@@ -83,20 +83,20 @@ scoop update compass
We provide ready to use Docker container images. To pull the latest image:
```
-docker pull odpf/compass:latest
+docker pull raystack/compass:latest
```
To pull a specific version:
```
-docker pull odpf/compass:v0.3.2
+docker pull raystack/compass:v0.3.2
```
If you like to have a shell alias that runs the latest version of compass from docker whenever you type `compass`:
```
-mkdir -p $HOME/.config/odpf
-alias compass="docker run -e HOME=/tmp -v $HOME/.config/odpf:/tmp/.config/odpf --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp odpf/compass:latest"
+mkdir -p $HOME/.config/raystack
+alias compass="docker run -e HOME=/tmp -v $HOME/.config/raystack:/tmp/.config/raystack --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp raystack/compass:latest"
```
## Usage
@@ -121,7 +121,7 @@ compass reference
#### API
-Compass provides a fully-featured GRPC and HTTP API to interact with Compass server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/odpf/proton/tree/main/odpf/compass/v1beta1) for GRPC API definitions.
+Compass provides a fully-featured GRPC and HTTP API to interact with Compass server. Both APIs adheres to a set of standards that are rigidly followed. Please refer to [proton](https://github.com/raystack/proton/tree/main/raystack/compass/v1beta1) for GRPC API definitions.
Dependencies:
@@ -166,7 +166,7 @@ docker build . -t compass
Before serving Compass app, we need to run the migration first. Run this docker command to migrate Compass.
```text
-$ docker run --rm --net compass_storage -p 8080:8080 -e ELASTICSEARCH_BROKERS=http://es:9200 -e DB_HOST=postgres -e DB_PORT=5432 -e DB_NAME=compass -e DB_USER=compass -e DB_PASSWORD=compass_password odpf/compass compass server migrate
+$ docker run --rm --net compass_storage -p 8080:8080 -e ELASTICSEARCH_BROKERS=http://es:9200 -e DB_HOST=postgres -e DB_PORT=5432 -e DB_NAME=compass -e DB_USER=compass -e DB_PASSWORD=compass_password raystack/compass compass server migrate
```
If you are using Compass binary, you can run this command.
@@ -180,7 +180,7 @@ If you are using Compass binary, you can run this command.
Once the migration has been done, Compass server can be started with this command.
```text
-docker run --net compass_storage -p 8080:8080 -e ELASTICSEARCH_BROKERS=http://es:9200 -e DB_HOST=postgres -e DB_PORT=5432 -e DB_NAME=compass -e DB_USER=compass -e DB_PASSWORD=compass_password odpf/compass compass server start
+docker run --net compass_storage -p 8080:8080 -e ELASTICSEARCH_BROKERS=http://es:9200 -e DB_HOST=postgres -e DB_PORT=5432 -e DB_NAME=compass -e DB_USER=compass -e DB_PASSWORD=compass_password raystack/compass compass server start
```
If you are using Compass binary, you can run this command.
@@ -204,11 +204,11 @@ elasticsearch cluster, set the value of `ES_TEST_SERVER_URL` to the URL of the e
Development of Compass happens in the open on GitHub, and we are grateful to the community for contributing bugfixes and improvements. Read below to learn how you can take part in improving Compass.
-Read our [contributing guide](https://odpf.github.io/compass/docs/contribute/contribution.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Compass.
+Read our [contributing guide](https://raystack.github.io/compass/docs/contribute/contribution.md) to learn about our development process, how to propose bugfixes and improvements, and how to build and test your changes to Compass.
-To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/odpf/compass/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
+To help you get your feet wet and get you familiar with our contribution process, we have a list of [good first issues](https://github.com/raystack/compass/labels/good%20first%20issue) that contain bugs which have a relatively limited scope. This is a great place to get started.
-This project exists thanks to all the [contributors](https://github.com/odpf/compass/graphs/contributors).
+This project exists thanks to all the [contributors](https://github.com/raystack/compass/graphs/contributors).
## License
diff --git a/cli/assets.go b/cli/assets.go
index e2b4bc63..d36d4adb 100644
--- a/cli/assets.go
+++ b/cli/assets.go
@@ -2,15 +2,15 @@ package cli
import (
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"os"
- "github.com/odpf/compass/internal/client"
- compassv1beta1 "github.com/odpf/compass/proto/odpf/compass/v1beta1"
- "github.com/odpf/salt/term"
+ "github.com/raystack/compass/internal/client"
+ compassv1beta1 "github.com/raystack/compass/proto/raystack/compass/v1beta1"
+ "github.com/raystack/salt/term"
"github.com/MakeNowJust/heredoc"
- "github.com/odpf/salt/printer"
+ "github.com/raystack/salt/printer"
"github.com/spf13/cobra"
)
diff --git a/cli/config.go b/cli/config.go
index ea340e82..6af37e88 100644
--- a/cli/config.go
+++ b/cli/config.go
@@ -6,14 +6,14 @@ import (
"os"
"github.com/MakeNowJust/heredoc"
- "github.com/odpf/compass/internal/client"
- "github.com/odpf/compass/internal/server"
- esStore "github.com/odpf/compass/internal/store/elasticsearch"
- "github.com/odpf/compass/internal/store/postgres"
- "github.com/odpf/compass/pkg/metrics"
- "github.com/odpf/compass/pkg/statsd"
- "github.com/odpf/salt/cmdx"
- "github.com/odpf/salt/config"
+ "github.com/raystack/compass/internal/client"
+ "github.com/raystack/compass/internal/server"
+ esStore "github.com/raystack/compass/internal/store/elasticsearch"
+ "github.com/raystack/compass/internal/store/postgres"
+ "github.com/raystack/compass/pkg/metrics"
+ "github.com/raystack/compass/pkg/statsd"
+ "github.com/raystack/salt/cmdx"
+ "github.com/raystack/salt/config"
"github.com/spf13/cobra"
"gopkg.in/yaml.v2"
)
diff --git a/cli/discussions.go b/cli/discussions.go
index 11317bee..cfa0b3a7 100644
--- a/cli/discussions.go
+++ b/cli/discussions.go
@@ -2,13 +2,13 @@ package cli
import (
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"os"
- "github.com/odpf/compass/internal/client"
- compassv1beta1 "github.com/odpf/compass/proto/odpf/compass/v1beta1"
- "github.com/odpf/salt/printer"
- "github.com/odpf/salt/term"
+ "github.com/raystack/compass/internal/client"
+ compassv1beta1 "github.com/raystack/compass/proto/raystack/compass/v1beta1"
+ "github.com/raystack/salt/printer"
+ "github.com/raystack/salt/term"
"github.com/MakeNowJust/heredoc"
"github.com/spf13/cobra"
diff --git a/cli/help.go b/cli/help.go
index 8a0de2c8..be6bd065 100644
--- a/cli/help.go
+++ b/cli/help.go
@@ -7,8 +7,8 @@ import (
var envHelp = map[string]string{
"short": "List of supported environment variables",
"long": heredoc.Doc(`
- ODPF_CONFIG_DIR: the directory where compass will store configuration files. Default:
- "$XDG_CONFIG_HOME/odpf" or "$HOME/.config/odpf".
+ RAYSTACK_CONFIG_DIR: the directory where compass will store configuration files. Default:
+ "$XDG_CONFIG_HOME/raystack" or "$HOME/.config/raystack".
NO_COLOR: set to any value to avoid printing ANSI escape sequences for color output.
diff --git a/cli/lineage.go b/cli/lineage.go
index 9a475f9d..ab28c19c 100644
--- a/cli/lineage.go
+++ b/cli/lineage.go
@@ -2,13 +2,13 @@ package cli
import (
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"github.com/MakeNowJust/heredoc"
- "github.com/odpf/compass/internal/client"
- compassv1beta1 "github.com/odpf/compass/proto/odpf/compass/v1beta1"
- "github.com/odpf/salt/printer"
- "github.com/odpf/salt/term"
+ "github.com/raystack/compass/internal/client"
+ compassv1beta1 "github.com/raystack/compass/proto/raystack/compass/v1beta1"
+ "github.com/raystack/salt/printer"
+ "github.com/raystack/salt/term"
"github.com/spf13/cobra"
)
diff --git a/cli/namespace.go b/cli/namespace.go
index 2d72e148..6d37701d 100644
--- a/cli/namespace.go
+++ b/cli/namespace.go
@@ -3,14 +3,14 @@ package cli
import (
"errors"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"os"
"strings"
- "github.com/odpf/compass/internal/client"
- compassv1beta1 "github.com/odpf/compass/proto/odpf/compass/v1beta1"
- "github.com/odpf/salt/printer"
- "github.com/odpf/salt/term"
+ "github.com/raystack/compass/internal/client"
+ compassv1beta1 "github.com/raystack/compass/proto/raystack/compass/v1beta1"
+ "github.com/raystack/salt/printer"
+ "github.com/raystack/salt/term"
"github.com/MakeNowJust/heredoc"
"github.com/spf13/cobra"
diff --git a/cli/root.go b/cli/root.go
index 4658cfdb..67fb2a09 100644
--- a/cli/root.go
+++ b/cli/root.go
@@ -2,7 +2,7 @@ package cli
import (
"github.com/MakeNowJust/heredoc"
- "github.com/odpf/salt/cmdx"
+ "github.com/raystack/salt/cmdx"
"github.com/spf13/cobra"
)
@@ -23,10 +23,10 @@ var (
"group": "core",
"help:learn": heredoc.Doc(`
Use 'compass --help' for info about a command.
- Read the manual at https://odpf.github.io/compass/
+ Read the manual at https://raystack.github.io/compass/
`),
"help:feedback": heredoc.Doc(`
- Open an issue here https://github.com/odpf/compass/issues
+ Open an issue here https://github.com/raystack/compass/issues
`),
},
}
diff --git a/cli/search.go b/cli/search.go
index 4483fa1b..61b36243 100644
--- a/cli/search.go
+++ b/cli/search.go
@@ -2,13 +2,13 @@ package cli
import (
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"github.com/MakeNowJust/heredoc"
- "github.com/odpf/compass/internal/client"
- compassv1beta1 "github.com/odpf/compass/proto/odpf/compass/v1beta1"
- "github.com/odpf/salt/printer"
- "github.com/odpf/salt/term"
+ "github.com/raystack/compass/internal/client"
+ compassv1beta1 "github.com/raystack/compass/proto/raystack/compass/v1beta1"
+ "github.com/raystack/salt/printer"
+ "github.com/raystack/salt/term"
"github.com/spf13/cobra"
)
diff --git a/cli/server.go b/cli/server.go
index 60110375..affe576f 100644
--- a/cli/server.go
+++ b/cli/server.go
@@ -3,23 +3,23 @@ package cli
import (
"context"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"os"
"os/signal"
"syscall"
"github.com/MakeNowJust/heredoc"
"github.com/newrelic/go-agent/v3/newrelic"
- "github.com/odpf/compass/core/asset"
- "github.com/odpf/compass/core/discussion"
- "github.com/odpf/compass/core/star"
- "github.com/odpf/compass/core/tag"
- "github.com/odpf/compass/core/user"
- compassserver "github.com/odpf/compass/internal/server"
- esStore "github.com/odpf/compass/internal/store/elasticsearch"
- "github.com/odpf/compass/internal/store/postgres"
- "github.com/odpf/compass/pkg/statsd"
- "github.com/odpf/salt/log"
+ "github.com/raystack/compass/core/asset"
+ "github.com/raystack/compass/core/discussion"
+ "github.com/raystack/compass/core/star"
+ "github.com/raystack/compass/core/tag"
+ "github.com/raystack/compass/core/user"
+ compassserver "github.com/raystack/compass/internal/server"
+ esStore "github.com/raystack/compass/internal/store/elasticsearch"
+ "github.com/raystack/compass/internal/store/postgres"
+ "github.com/raystack/compass/pkg/statsd"
+ "github.com/raystack/salt/log"
"github.com/spf13/cobra"
)
diff --git a/cli/version.go b/cli/version.go
index af3fb49e..471a2725 100644
--- a/cli/version.go
+++ b/cli/version.go
@@ -3,8 +3,8 @@ package cli
import (
"fmt"
- "github.com/odpf/salt/term"
- "github.com/odpf/salt/version"
+ "github.com/raystack/salt/term"
+ "github.com/raystack/salt/version"
"github.com/spf13/cobra"
)
@@ -21,7 +21,7 @@ func versionCmd() *cobra.Command {
}
fmt.Printf("compass version %s", Version)
- fmt.Println(term.Yellow(version.UpdateNotice(Version, "odpf/compass")))
+ fmt.Println(term.Yellow(version.UpdateNotice(Version, "raystack/compass")))
return nil
},
}
diff --git a/compass.yaml.example b/compass.yaml.example
index 6f89f054..1197240a 100644
--- a/compass.yaml.example
+++ b/compass.yaml.example
@@ -36,4 +36,4 @@ service:
client:
host: localhost:8081
serverheaderkey_uuid: Compass-User-UUID // if ommited, will use value on service.identity.headerkey_uuid
- serverheadervalue_uuid: odpf@email.com
+ serverheadervalue_uuid: raystack@email.com
diff --git a/core/asset/asset.go b/core/asset/asset.go
index 9c98fb4c..36f0cd92 100644
--- a/core/asset/asset.go
+++ b/core/asset/asset.go
@@ -3,10 +3,10 @@ package asset
//go:generate mockery --name=Repository -r --case underscore --with-expecter --structname AssetRepository --filename asset_repository.go --output=./mocks
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"time"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
"github.com/r3labs/diff/v2"
)
diff --git a/core/asset/asset_test.go b/core/asset/asset_test.go
index 2036edc2..00b74674 100644
--- a/core/asset/asset_test.go
+++ b/core/asset/asset_test.go
@@ -4,8 +4,8 @@ import (
"encoding/json"
"testing"
- "github.com/odpf/compass/core/asset"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/asset"
+ "github.com/raystack/compass/core/user"
"github.com/r3labs/diff/v2"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
@@ -59,12 +59,12 @@ func TestDiffTopLevel(t *testing.T) {
"name": "old-name",
"owners": [
{
- "email": "email@odpf.io"
+ "email": "email@raystack.io"
}
]
}`,
diff.Changelog{
- diff.Change{Type: diff.CREATE, Path: []string{"owners", "0", "email"}, To: "email@odpf.io"},
+ diff.Change{Type: diff.CREATE, Path: []string{"owners", "0", "email"}, To: "email@raystack.io"},
},
nil,
},
@@ -113,7 +113,7 @@ func TestDiffData(t *testing.T) {
"description": "",
"data": {
"title": "jane-kafka-1a",
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -124,7 +124,7 @@ func TestDiffData(t *testing.T) {
"data": {
"title": "jane-kafka-1a",
"description": "a new description inside",
- "entity": "odpf",
+ "entity": "raystack",
"country": "id"
}
}`,
@@ -144,7 +144,7 @@ func TestDiffData(t *testing.T) {
"id": "element1id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -156,7 +156,7 @@ func TestDiffData(t *testing.T) {
"id": "element2id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -175,7 +175,7 @@ func TestDiffData(t *testing.T) {
"id": "element1id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -190,7 +190,7 @@ func TestDiffData(t *testing.T) {
"id": "element2id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -212,7 +212,7 @@ func TestDiffData(t *testing.T) {
"id": "element2id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -224,7 +224,7 @@ func TestDiffData(t *testing.T) {
"id": "element1id"
}
],
- "entity": "odpf",
+ "entity": "raystack",
"country": "vn"
}
}`,
@@ -409,7 +409,7 @@ func TestAssetPatch(t *testing.T) {
},
"properties": map[string]interface{}{
"attributes": map[string]interface{}{
- "entity": "odpf",
+ "entity": "raystack",
"environment": "staging",
},
},
@@ -442,7 +442,7 @@ func TestAssetPatch(t *testing.T) {
},
"properties": map[string]interface{}{
"attributes": map[string]interface{}{
- "entity": "odpf",
+ "entity": "raystack",
"environment": "production",
"type": "some-type",
},
diff --git a/core/asset/discovery.go b/core/asset/discovery.go
index 0d334c8e..7394cf5a 100644
--- a/core/asset/discovery.go
+++ b/core/asset/discovery.go
@@ -3,8 +3,8 @@ package asset
//go:generate mockery --name=DiscoveryRepository -r --case underscore --with-expecter --structname DiscoveryRepository --filename discovery_repository.go --output=./mocks
import (
"context"
- "github.com/odpf/compass/core/namespace"
- "github.com/odpf/compass/core/validator"
+ "github.com/raystack/compass/core/namespace"
+ "github.com/raystack/compass/core/validator"
)
type DiscoveryRepository interface {
diff --git a/core/asset/discovery_test.go b/core/asset/discovery_test.go
index cea354b4..1fadd91d 100644
--- a/core/asset/discovery_test.go
+++ b/core/asset/discovery_test.go
@@ -1,12 +1,12 @@
package asset_test
import (
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"github.com/stretchr/testify/assert"
"testing"
"github.com/google/go-cmp/cmp"
- "github.com/odpf/compass/core/asset"
+ "github.com/raystack/compass/core/asset"
)
func TestToAsset(t *testing.T) {
diff --git a/core/asset/filter.go b/core/asset/filter.go
index b638a3da..2caf617a 100644
--- a/core/asset/filter.go
+++ b/core/asset/filter.go
@@ -3,7 +3,7 @@ package asset
import (
"strings"
- "github.com/odpf/compass/core/validator"
+ "github.com/raystack/compass/core/validator"
)
type Filter struct {
diff --git a/core/asset/filter_test.go b/core/asset/filter_test.go
index 5f741e02..f61afbda 100644
--- a/core/asset/filter_test.go
+++ b/core/asset/filter_test.go
@@ -3,7 +3,7 @@ package asset_test
import (
"testing"
- "github.com/odpf/compass/core/asset"
+ "github.com/raystack/compass/core/asset"
"github.com/stretchr/testify/assert"
)
diff --git a/core/asset/lineage.go b/core/asset/lineage.go
index 55c436ff..d925cb67 100644
--- a/core/asset/lineage.go
+++ b/core/asset/lineage.go
@@ -3,7 +3,7 @@ package asset
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
)
type LineageDirection string
diff --git a/core/asset/mocks/asset_repository.go b/core/asset/mocks/asset_repository.go
index 82f39394..f19d21ff 100644
--- a/core/asset/mocks/asset_repository.go
+++ b/core/asset/mocks/asset_repository.go
@@ -5,11 +5,11 @@ package mocks
import (
context "context"
- asset "github.com/odpf/compass/core/asset"
+ asset "github.com/raystack/compass/core/asset"
mock "github.com/stretchr/testify/mock"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
)
// AssetRepository is an autogenerated mock type for the Repository type
diff --git a/core/asset/mocks/discovery_repository.go b/core/asset/mocks/discovery_repository.go
index 86e174dc..97c77d1a 100644
--- a/core/asset/mocks/discovery_repository.go
+++ b/core/asset/mocks/discovery_repository.go
@@ -5,11 +5,11 @@ package mocks
import (
context "context"
- asset "github.com/odpf/compass/core/asset"
+ asset "github.com/raystack/compass/core/asset"
mock "github.com/stretchr/testify/mock"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
)
// DiscoveryRepository is an autogenerated mock type for the DiscoveryRepository type
diff --git a/core/asset/mocks/lineage_repository.go b/core/asset/mocks/lineage_repository.go
index aa2b3a54..73cd9911 100644
--- a/core/asset/mocks/lineage_repository.go
+++ b/core/asset/mocks/lineage_repository.go
@@ -5,11 +5,11 @@ package mocks
import (
context "context"
- asset "github.com/odpf/compass/core/asset"
+ asset "github.com/raystack/compass/core/asset"
mock "github.com/stretchr/testify/mock"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
)
// LineageRepository is an autogenerated mock type for the LineageRepository type
diff --git a/core/asset/patch.go b/core/asset/patch.go
index bac52f34..33128f26 100644
--- a/core/asset/patch.go
+++ b/core/asset/patch.go
@@ -1,7 +1,7 @@
package asset
import (
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
"github.com/peterbourgon/mergemap"
)
diff --git a/core/asset/service.go b/core/asset/service.go
index e847b9d8..87ccb939 100644
--- a/core/asset/service.go
+++ b/core/asset/service.go
@@ -4,7 +4,7 @@ import (
"context"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"github.com/google/uuid"
)
diff --git a/core/asset/service_test.go b/core/asset/service_test.go
index 016f03bd..e745d709 100644
--- a/core/asset/service_test.go
+++ b/core/asset/service_test.go
@@ -4,13 +4,13 @@ import (
"context"
"errors"
"github.com/google/uuid"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"testing"
"time"
"github.com/google/go-cmp/cmp"
- "github.com/odpf/compass/core/asset"
- "github.com/odpf/compass/core/asset/mocks"
+ "github.com/raystack/compass/core/asset"
+ "github.com/raystack/compass/core/asset/mocks"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/comment.go b/core/discussion/comment.go
index 3003724d..26ca2129 100644
--- a/core/discussion/comment.go
+++ b/core/discussion/comment.go
@@ -5,7 +5,7 @@ import (
"strings"
"time"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
)
type Comment struct {
diff --git a/core/discussion/comment_test.go b/core/discussion/comment_test.go
index 90a7c0c0..ec11058e 100644
--- a/core/discussion/comment_test.go
+++ b/core/discussion/comment_test.go
@@ -4,7 +4,7 @@ import (
"fmt"
"testing"
- "github.com/odpf/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/discussion.go b/core/discussion/discussion.go
index 7c8a2bb2..2a40b974 100644
--- a/core/discussion/discussion.go
+++ b/core/discussion/discussion.go
@@ -5,11 +5,11 @@ package discussion
import (
"context"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"strings"
"time"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
)
const MAX_ARRAY_FIELD_NUM = 10
diff --git a/core/discussion/discussion_test.go b/core/discussion/discussion_test.go
index 04f89c0d..035db01a 100644
--- a/core/discussion/discussion_test.go
+++ b/core/discussion/discussion_test.go
@@ -5,7 +5,7 @@ import (
"testing"
"time"
- "github.com/odpf/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/filter.go b/core/discussion/filter.go
index 1e96ac3d..e43412ce 100644
--- a/core/discussion/filter.go
+++ b/core/discussion/filter.go
@@ -3,7 +3,7 @@ package discussion
import (
"strings"
- validator "github.com/odpf/compass/core/validator"
+ validator "github.com/raystack/compass/core/validator"
)
type Filter struct {
diff --git a/core/discussion/filter_test.go b/core/discussion/filter_test.go
index e0486adc..3efa6aed 100644
--- a/core/discussion/filter_test.go
+++ b/core/discussion/filter_test.go
@@ -4,7 +4,7 @@ import (
"testing"
"github.com/google/go-cmp/cmp"
- "github.com/odpf/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/mocks/discussion_repository.go b/core/discussion/mocks/discussion_repository.go
index 46b5da77..f8f697bc 100644
--- a/core/discussion/mocks/discussion_repository.go
+++ b/core/discussion/mocks/discussion_repository.go
@@ -5,10 +5,10 @@ package mocks
import (
context "context"
- discussion "github.com/odpf/compass/core/discussion"
+ discussion "github.com/raystack/compass/core/discussion"
mock "github.com/stretchr/testify/mock"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
)
// DiscussionRepository is an autogenerated mock type for the Repository type
diff --git a/core/discussion/service.go b/core/discussion/service.go
index 46de21cd..dd6e804d 100644
--- a/core/discussion/service.go
+++ b/core/discussion/service.go
@@ -2,7 +2,7 @@ package discussion
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
)
func NewService(discussionRepository Repository) *Service {
diff --git a/core/discussion/service_test.go b/core/discussion/service_test.go
index ed7355c6..31f6bcb0 100644
--- a/core/discussion/service_test.go
+++ b/core/discussion/service_test.go
@@ -4,11 +4,11 @@ import (
"context"
"errors"
"github.com/google/uuid"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"testing"
- "github.com/odpf/compass/core/discussion"
- "github.com/odpf/compass/core/discussion/mocks"
+ "github.com/raystack/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion/mocks"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/state_test.go b/core/discussion/state_test.go
index 64d79476..aaaf31ef 100644
--- a/core/discussion/state_test.go
+++ b/core/discussion/state_test.go
@@ -3,7 +3,7 @@ package discussion_test
import (
"testing"
- "github.com/odpf/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion"
"github.com/stretchr/testify/assert"
)
diff --git a/core/discussion/type_test.go b/core/discussion/type_test.go
index 5e7e2e3d..c70a50cd 100644
--- a/core/discussion/type_test.go
+++ b/core/discussion/type_test.go
@@ -3,7 +3,7 @@ package discussion_test
import (
"testing"
- "github.com/odpf/compass/core/discussion"
+ "github.com/raystack/compass/core/discussion"
"github.com/stretchr/testify/assert"
)
diff --git a/core/namespace/mocks/discovery_repository.go b/core/namespace/mocks/discovery_repository.go
index 3f74c368..6703691f 100644
--- a/core/namespace/mocks/discovery_repository.go
+++ b/core/namespace/mocks/discovery_repository.go
@@ -5,7 +5,7 @@ package mocks
import (
context "context"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
mock "github.com/stretchr/testify/mock"
)
diff --git a/core/namespace/mocks/storage_repository.go b/core/namespace/mocks/storage_repository.go
index 140322c3..6ca216a1 100644
--- a/core/namespace/mocks/storage_repository.go
+++ b/core/namespace/mocks/storage_repository.go
@@ -5,7 +5,7 @@ package mocks
import (
context "context"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
mock "github.com/stretchr/testify/mock"
uuid "github.com/google/uuid"
diff --git a/core/namespace/service.go b/core/namespace/service.go
index acdd613f..b55afa26 100644
--- a/core/namespace/service.go
+++ b/core/namespace/service.go
@@ -3,7 +3,7 @@ package namespace
import (
"context"
"github.com/google/uuid"
- "github.com/odpf/salt/log"
+ "github.com/raystack/salt/log"
)
type Service struct {
diff --git a/core/namespace/service_test.go b/core/namespace/service_test.go
index fe41ebca..046a45d4 100644
--- a/core/namespace/service_test.go
+++ b/core/namespace/service_test.go
@@ -4,9 +4,9 @@ import (
"context"
"errors"
"github.com/google/uuid"
- "github.com/odpf/compass/core/namespace"
- "github.com/odpf/compass/core/namespace/mocks"
- "github.com/odpf/salt/log"
+ "github.com/raystack/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace/mocks"
+ "github.com/raystack/salt/log"
"github.com/stretchr/testify/assert"
"testing"
)
diff --git a/core/star/mocks/star_repository.go b/core/star/mocks/star_repository.go
index 335b19c5..84f4a499 100644
--- a/core/star/mocks/star_repository.go
+++ b/core/star/mocks/star_repository.go
@@ -5,15 +5,15 @@ package mocks
import (
context "context"
- asset "github.com/odpf/compass/core/asset"
+ asset "github.com/raystack/compass/core/asset"
mock "github.com/stretchr/testify/mock"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
- star "github.com/odpf/compass/core/star"
+ star "github.com/raystack/compass/core/star"
- user "github.com/odpf/compass/core/user"
+ user "github.com/raystack/compass/core/user"
)
// StarRepository is an autogenerated mock type for the Repository type
diff --git a/core/star/service.go b/core/star/service.go
index 3b03f495..c5da6046 100644
--- a/core/star/service.go
+++ b/core/star/service.go
@@ -2,10 +2,10 @@ package star
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
- "github.com/odpf/compass/core/asset"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/asset"
+ "github.com/raystack/compass/core/user"
)
func NewService(starRepository Repository) *Service {
diff --git a/core/star/star.go b/core/star/star.go
index 1da9e5b5..f934e046 100644
--- a/core/star/star.go
+++ b/core/star/star.go
@@ -4,10 +4,10 @@ package star
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
- "github.com/odpf/compass/core/asset"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/asset"
+ "github.com/raystack/compass/core/user"
)
type Repository interface {
diff --git a/core/tag/mocks/tag_repository.go b/core/tag/mocks/tag_repository.go
index 45e9b39a..aa2260b5 100644
--- a/core/tag/mocks/tag_repository.go
+++ b/core/tag/mocks/tag_repository.go
@@ -5,10 +5,10 @@ package mocks
import (
context "context"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
mock "github.com/stretchr/testify/mock"
- tag "github.com/odpf/compass/core/tag"
+ tag "github.com/raystack/compass/core/tag"
)
// TagRepository is an autogenerated mock type for the TagRepository type
diff --git a/core/tag/mocks/tag_template_repository.go b/core/tag/mocks/tag_template_repository.go
index 0d245154..06f9490c 100644
--- a/core/tag/mocks/tag_template_repository.go
+++ b/core/tag/mocks/tag_template_repository.go
@@ -5,10 +5,10 @@ package mocks
import (
context "context"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
mock "github.com/stretchr/testify/mock"
- tag "github.com/odpf/compass/core/tag"
+ tag "github.com/raystack/compass/core/tag"
)
// TagTemplateRepository is an autogenerated mock type for the TagTemplateRepository type
diff --git a/core/tag/service.go b/core/tag/service.go
index aed52b17..c0862f49 100644
--- a/core/tag/service.go
+++ b/core/tag/service.go
@@ -4,9 +4,9 @@ import (
"context"
"errors"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag/validator"
)
// Service is a type that manages business process
diff --git a/core/tag/service_test.go b/core/tag/service_test.go
index f44c19cc..342a2ec4 100644
--- a/core/tag/service_test.go
+++ b/core/tag/service_test.go
@@ -4,13 +4,13 @@ import (
"context"
"errors"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"testing"
"github.com/google/uuid"
- "github.com/odpf/compass/core/tag"
- "github.com/odpf/compass/core/tag/mocks"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag"
+ "github.com/raystack/compass/core/tag/mocks"
+ "github.com/raystack/compass/core/tag/validator"
"github.com/golang-module/carbon/v2"
"github.com/stretchr/testify/mock"
diff --git a/core/tag/tag.go b/core/tag/tag.go
index 1f690bad..9eb117ed 100644
--- a/core/tag/tag.go
+++ b/core/tag/tag.go
@@ -3,7 +3,7 @@ package tag
//go:generate mockery --name=TagRepository -r --case underscore --with-expecter --structname TagRepository --filename tag_repository.go --output=./mocks
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"time"
)
diff --git a/core/tag/tag_template.go b/core/tag/tag_template.go
index 7652fa1d..06f9efa9 100644
--- a/core/tag/tag_template.go
+++ b/core/tag/tag_template.go
@@ -4,7 +4,7 @@ package tag
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"time"
)
diff --git a/core/tag/tag_template_service.go b/core/tag/tag_template_service.go
index 70a3f525..cfa8f3e5 100644
--- a/core/tag/tag_template_service.go
+++ b/core/tag/tag_template_service.go
@@ -4,9 +4,9 @@ import (
"context"
"errors"
"fmt"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag/validator"
)
// TemplateService is a type of service that manages business process
diff --git a/core/tag/tag_template_service_test.go b/core/tag/tag_template_service_test.go
index b0da8bfb..17f2ca85 100644
--- a/core/tag/tag_template_service_test.go
+++ b/core/tag/tag_template_service_test.go
@@ -5,13 +5,13 @@ import (
"errors"
"fmt"
"github.com/google/uuid"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"testing"
"time"
- "github.com/odpf/compass/core/tag"
- "github.com/odpf/compass/core/tag/mocks"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag"
+ "github.com/raystack/compass/core/tag/mocks"
+ "github.com/raystack/compass/core/tag/validator"
"github.com/stretchr/testify/mock"
"github.com/stretchr/testify/suite"
diff --git a/core/tag/utils.go b/core/tag/utils.go
index 12de50bf..f9d7dffd 100644
--- a/core/tag/utils.go
+++ b/core/tag/utils.go
@@ -6,7 +6,7 @@ import (
"strings"
"time"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag/validator"
)
func buildFieldError(key string, message string) error {
diff --git a/core/tag/validator.go b/core/tag/validator.go
index 1a8bfe09..ae1a6054 100644
--- a/core/tag/validator.go
+++ b/core/tag/validator.go
@@ -5,7 +5,7 @@ import (
ut "github.com/go-playground/universal-translator"
v "github.com/go-playground/validator/v10"
- "github.com/odpf/compass/core/tag/validator"
+ "github.com/raystack/compass/core/tag/validator"
)
// newValidator initializes validator for tag
diff --git a/core/user/context_test.go b/core/user/context_test.go
index 462541cc..350e653d 100644
--- a/core/user/context_test.go
+++ b/core/user/context_test.go
@@ -5,7 +5,7 @@ import (
"testing"
"github.com/google/go-cmp/cmp"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
)
func TestContext(t *testing.T) {
diff --git a/core/user/errors_test.go b/core/user/errors_test.go
index 7f75a5d3..d6631951 100644
--- a/core/user/errors_test.go
+++ b/core/user/errors_test.go
@@ -3,7 +3,7 @@ package user_test
import (
"testing"
- "github.com/odpf/compass/core/user"
+ "github.com/raystack/compass/core/user"
)
func TestErrors(t *testing.T) {
diff --git a/core/user/mocks/user_repository.go b/core/user/mocks/user_repository.go
index 8988990e..96257d9a 100644
--- a/core/user/mocks/user_repository.go
+++ b/core/user/mocks/user_repository.go
@@ -5,10 +5,10 @@ package mocks
import (
context "context"
- namespace "github.com/odpf/compass/core/namespace"
+ namespace "github.com/raystack/compass/core/namespace"
mock "github.com/stretchr/testify/mock"
- user "github.com/odpf/compass/core/user"
+ user "github.com/raystack/compass/core/user"
)
// UserRepository is an autogenerated mock type for the Repository type
diff --git a/core/user/service.go b/core/user/service.go
index 12265f30..5efc74dc 100644
--- a/core/user/service.go
+++ b/core/user/service.go
@@ -3,10 +3,10 @@ package user
import (
"context"
"errors"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
- "github.com/odpf/compass/pkg/statsd"
- "github.com/odpf/salt/log"
+ "github.com/raystack/compass/pkg/statsd"
+ "github.com/raystack/salt/log"
)
// Service is a type of service that manages business process
diff --git a/core/user/service_test.go b/core/user/service_test.go
index 3eee89bc..a4828bb8 100644
--- a/core/user/service_test.go
+++ b/core/user/service_test.go
@@ -4,13 +4,13 @@ import (
"context"
"errors"
"github.com/google/uuid"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"testing"
- "github.com/odpf/compass/core/user"
- "github.com/odpf/compass/core/user/mocks"
- "github.com/odpf/compass/pkg/statsd"
- "github.com/odpf/salt/log"
+ "github.com/raystack/compass/core/user"
+ "github.com/raystack/compass/core/user/mocks"
+ "github.com/raystack/compass/pkg/statsd"
+ "github.com/raystack/salt/log"
"github.com/stretchr/testify/assert"
)
diff --git a/core/user/user.go b/core/user/user.go
index 82d0eadb..07adb169 100644
--- a/core/user/user.go
+++ b/core/user/user.go
@@ -3,7 +3,7 @@ package user
//go:generate mockery --name=Repository -r --case underscore --with-expecter --structname UserRepository --filename user_repository.go --output=./mocks
import (
"context"
- "github.com/odpf/compass/core/namespace"
+ "github.com/raystack/compass/core/namespace"
"time"
)
diff --git a/core/validator/validator_test.go b/core/validator/validator_test.go
index e6b34e62..e96e6902 100644
--- a/core/validator/validator_test.go
+++ b/core/validator/validator_test.go
@@ -3,7 +3,7 @@ package validator_test
import (
"testing"
- "github.com/odpf/compass/core/validator"
+ "github.com/raystack/compass/core/validator"
"gotest.tools/assert"
)
diff --git a/docs/docs/concepts/architecture.md b/docs/docs/concepts/architecture.md
index 3e615d78..2391c7c5 100644
--- a/docs/docs/concepts/architecture.md
+++ b/docs/docs/concepts/architecture.md
@@ -11,7 +11,7 @@ Compass' architecture is pretty simple. It has a client-server architecture back
#### gRPC Server
- gRPC server is the main interface to interact with Compass.
-- The protobuf file to define the interface is centralized in [odpf/proton](https://github.com/odpf/proton/tree/main/odpf/compass/v1beta1)
+- The protobuf file to define the interface is centralized in [raystack/proton](https://github.com/raystack/proton/tree/main/raystack/compass/v1beta1)
#### gRPC-gateway Server
diff --git a/docs/docs/concepts/asset.mdx b/docs/docs/concepts/asset.mdx
index 26da255f..88005506 100644
--- a/docs/docs/concepts/asset.mdx
+++ b/docs/docs/concepts/asset.mdx
@@ -1,5 +1,5 @@
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
+import Tabs from "@theme/Tabs";
+import TabItem from "@theme/TabItem";
# Asset
@@ -8,17 +8,17 @@ In Compass, we call every metadata that you input as an Asset. All your tables,
-| Field | Required | Type | Description |
-|---|---|---|---|
-| id | false | string | compass' auto-generated uuid |
-| urn | true | string | external identifier of the metadata |
-| type | true | string | type of metadata, only supports `table`, `job`, `topic`,`dashboard` |
-| service | true | string | application name where the metadata was coming from e.g. `bigquery`, `postgres` |
-| name | true | string | name of the metadata |
-| description | false | string | description of the metadata |
-| data | false | json | dynamic data |
-| labels | false |json | labels of metadata, written in key-value string |
-| owners | false | []json | array of json, where each json contains `email` field |
+| Field | Required | Type | Description |
+| ----------- | -------- | ------ | ------------------------------------------------------------------------------- |
+| id | false | string | compass' auto-generated uuid |
+| urn | true | string | external identifier of the metadata |
+| type | true | string | type of metadata, only supports `table`, `job`, `topic`,`dashboard` |
+| service | true | string | application name where the metadata was coming from e.g. `bigquery`, `postgres` |
+| name | true | string | name of the metadata |
+| description | false | string | description of the metadata |
+| data | false | json | dynamic data |
+| labels | false | json | labels of metadata, written in key-value string |
+| owners | false | []json | array of json, where each json contains `email` field |
@@ -36,16 +36,16 @@ In Compass, we call every metadata that you input as an Asset. All your tables,
"nested_data": {
"boolean_data": true
}
- },
+ },
"some_data1": "value"
}
"labels": {
- "labelkey1": "labelvalue1",
+ "labelkey1": "labelvalue1",
"labelkey2": "labelvalue2"
},
"users": [
{
- "email": "user@odpf.io"
+ "email": "user@raystack.io"
}
]
}
@@ -54,8 +54,7 @@ In Compass, we call every metadata that you input as an Asset. All your tables,
-
-Every asset that is pushed SHOULD have the required fields: `urn`, `type`, `service`, `name`. The value of these fields MUST be string, if present.
+Every asset that is pushed SHOULD have the required fields: `urn`, `type`, `service`, `name`. The value of these fields MUST be string, if present.
Asset ingestion API (`/v1beta1/assets`) is using HTTP PATCH method. The behavioud would be similar with how PATCH works. It is possible to patch one field only in an asset by sending the updated field to the ingestion API. This also works for the data in dynamic `data` field. The combination of `urn`, `type`, `service` will be the identifier to patch an asset.
In case the `urn` does not exist, the asset ingestion PATCH API \(/v1beta1/assets\) will create a new asset.
@@ -67,6 +66,7 @@ Lineage is the origin or history of an asset. It represents a series of transfor
Each asset can have downstream/s and upstream/s. An asset without a single downstream, tells us that it is the end of the lineage, while an asset without a single upstream means that it is a start of a lineage.
This is how a lineage is currently being represented
+
```text
[
{
@@ -81,7 +81,7 @@ This is how a lineage is currently being represented
"service": "bigquery"
},
"props": nil
- },
+ },
{
"source": {
"urn": "topic/order-log",
@@ -99,11 +99,13 @@ This is how a lineage is currently being represented
```
## Asset Versioning
-Compass versions each updated asset ingested via Upsert Patch API. The base version of an asset is `v0.1`. The base version will be given to the newly created asset. If there is any changes in the asset schema, a new version will be created.
-Up until now, Compass always bump up the minor version if an asset get updated. The version history of an asset could also be fetched via [/v1beta1/assets/{id}/versions](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json) API.
+
+Compass versions each updated asset ingested via Upsert Patch API. The base version of an asset is `v0.1`. The base version will be given to the newly created asset. If there is any changes in the asset schema, a new version will be created.
+Up until now, Compass always bump up the minor version if an asset get updated. The version history of an asset could also be fetched via [/v1beta1/assets/{id}/versions](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json) API.
Not only storing the versions of an asset, Compass also stores the changelog between each version. Compass use [r3labs/diff](https://github.com/r3labs/diff) to get the diff between newly ingested asset and the existing asset.
For instance, there is an asset with urn `kafka:booking-log-kafka`
+
```text
{
"id": "f2bb4e02-12b6-4c9f-aa9d-7d56aaaeb51e",
@@ -119,6 +121,7 @@ For instance, there is an asset with urn `kafka:booking-log-kafka`
```
If there is an update to the `environment` in the asset labels, here is the asset version history stored in Compass:
+
```text
{
"id": "f2bb4e02-12b6-4c9f-aa9d-7d56aaaeb51e",
@@ -142,5 +145,6 @@ If there is an update to the `environment` in the asset labels, here is the asse
```
## Tagging an Asset
+
Compass allows user to tag a specific asset. To tag a new asset, one needs to create a template of the tag. Tag's template defines a set of fields' tag that are applicable to tag each field in an asset.
Once a template is created, each field in an asset is possible to be tagged by calling `/v1beta1/tags` API. More detail about [Tagging](../guides/tagging.md).
diff --git a/docs/docs/concepts/internals.md b/docs/docs/concepts/internals.md
index 757aa2ae..61b59c53 100644
--- a/docs/docs/concepts/internals.md
+++ b/docs/docs/concepts/internals.md
@@ -11,7 +11,7 @@ There is a migration command in compass to setup all storages. The indices are c
{
"mappings": {}, // used for boost
"aliases": { // all indices are aliased to the "universe" index
- "universe": {}
+ "universe": {}
},
"settings": { // configuration for handling camel case text
"analysis": {
@@ -27,13 +27,14 @@ There is a migration command in compass to setup all storages. The indices are c
```
One shared index is created for all services and tenants but each request(read/write) is routed to a unique shard for each tenant. Compass categorize tenants into two tires, `shared` and `dedicated`. For shared tenants, all the requests will be routed by namespace id over a single shard in an index. For dedicated tenants, each tenant will have its own index. Note, a single index will have N number of `types` same as the number of `Services` supported in Compass. This design will ensure, all the document insert/query requests are only confined to a single shard(in case of shared) or a single index(in case of dedicated).
-Details on why we did this is available at [issue #208](https://github.com/odpf/compass/issues/208).
+Details on why we did this is available at [issue #208](https://github.com/raystack/compass/issues/208).
## Postgres
To enforce multi-tenant restrictions at the database level, [Row Level Security](https://www.postgresql.org/docs/current/ddl-rowsecurity.html) is used. RLS requires Postgres users used for application database connection not to be a table owner or a superuser else all RLS are bypassed by default. That means a Postgres user that is migrating the application and a user that is used to serve the app should both be different.
To create a postgres user
+
```sql
CREATE USER "compass_user" WITH PASSWORD 'compass';
GRANT CONNECT ON DATABASE "compass" TO "compass_user";
@@ -47,7 +48,7 @@ ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT USAGE ON SEQUENCES TO "compass
ALTER DEFAULT PRIVILEGES IN SCHEMA "public" GRANT EXECUTE ON FUNCTIONS TO "compass_user";
```
-A middleware for grpc looks for `x-namespace-id` header to extract tenant id if not found falls back to `default` namespace.
+A middleware for grpc looks for `x-namespace-id` header to extract tenant id if not found falls back to `default` namespace.
Same could be passed in a `jwt token` of Authentication Bearer with `namespace_id` as a claim.
## Search
@@ -56,8 +57,8 @@ We use elasticsearch's `multi_match` search for running our queries. Depending o
The script filter is designed to match a document if:
-* the document contains the filter key and it's value matches the filter value OR
-* the document doesn't contain the filter key at all
+- the document contains the filter key and it's value matches the filter value OR
+- the document doesn't contain the filter key at all
To demonstrate, the following API call:
@@ -90,7 +91,7 @@ is internally translated to the following elasticsearch query
Compass also supports filter with fuzzy match with `query` query params. The script query is designed to match a document if:
-* the document contains the filter key and it's value is fuzzily matches the `query` value
+- the document contains the filter key and it's value is fuzzily matches the `query` value
```text
$ curl http://localhost:8080/v1beta1/search?text=log&filter[landscape]=id
@@ -135,7 +136,7 @@ is internally translated to the following elasticsearch query
{
"multi_match":{
"fields":[
-
+
],
"fuzziness":"AUTO",
"query":"log"
@@ -148,4 +149,4 @@ is internally translated to the following elasticsearch query
},
"min_score":0.01
}
-```
\ No newline at end of file
+```
diff --git a/docs/docs/configuration.md b/docs/docs/configuration.md
index 2e5168c2..360777c7 100644
--- a/docs/docs/configuration.md
+++ b/docs/docs/configuration.md
@@ -1,13 +1,14 @@
# Configuration
-Compass binary contains both the CLI client and the server. Each has it's own configuration in order to run. Server configuration contains information such as database credentials, elastic search brokers, log severity, etc. while CLI client configuration only has configuration about which server to connect.
+Compass binary contains both the CLI client and the server. Each has it's own configuration in order to run. Server configuration contains information such as database credentials, elastic search brokers, log severity, etc. while CLI client configuration only has configuration about which server to connect.
+
## Server Setup
There are several approaches to setup Compass Server
1. [Using the CLI](#using-the-cli)
1. [Using the Docker](#using-the-docker)
-2. [Using the Helm Chart](#using-the-helm-chart)
+1. [Using the Helm Chart](#using-the-helm-chart)
#### General pre-requisites
@@ -15,9 +16,10 @@ There are several approaches to setup Compass Server
- ElasticSearch v7 (optional)
## Using the CLI
+
### Using config file
-Create a config file with the following command
+Create a config file with the following command
```sh
$ compass config init
@@ -25,7 +27,7 @@ $ compass config init
alternatively you can [use `--config` flag](#using---config-flag) to customize to config file location.
-You can also [use environment variables](#using-environment-variable) to provide the server configuration.
+You can also [use environment variables](#using-environment-variable) to provide the server configuration.
Setup up the Postgres database, and ElasticSearch instance and provide the details as shown in the example below.
@@ -34,34 +36,35 @@ Setup up the Postgres database, and ElasticSearch instance and provide the detai
Following is a sample server configuration yaml:
```yaml title="compass.yaml"
-log_level: info # debug|info|warning|error|fatal|trace|panic - default: info
+log_level: info # debug|info|warning|error|fatal|trace|panic - default: info
elasticsearch:
- brokers: http://localhost:9200 #required
+ brokers: http://localhost:9200 #required
db:
- host: localhost #required
- port: 5432 #required
- name: compass #required
- user: compass #required
- password: compass_password #required
- sslmode: disable #optional
+ host: localhost #required
+ port: 5432 #required
+ name: compass #required
+ user: compass #required
+ password: compass_password #required
+ sslmode: disable #optional
service:
- host: localhost #required
- port: 8080 #required
- identity:
- headerkey_uuid: Compass-User-UUID #required
- headerkey_email: Compass-User-Email #optional
- provider_default_name: shield #optional
- grpc:
- port: 8081 #required
- max_send_msg_size: 33554432
- max_recv_msg_size: 33554432
+ host: localhost #required
+ port: 8080 #required
+ identity:
+ headerkey_uuid: Compass-User-UUID #required
+ headerkey_email: Compass-User-Email #optional
+ provider_default_name: shield #optional
+ grpc:
+ port: 8081 #required
+ max_send_msg_size: 33554432
+ max_recv_msg_size: 33554432
```
+
### Using environment variable
-All the server configurations can be passed as environment variables using underscore _ as the delimiter between nested keys.
+All the server configurations can be passed as environment variables using underscore \_ as the delimiter between nested keys.
See [configuration reference](./reference/configuration.md) for the list of all the configuration keys.
@@ -85,14 +88,17 @@ SERVICE_GRPC_MAX_RECV_MSG_SIZE=33554432
```
Set the env variable using export
+
```bash
$ export DB_PORT = 5432
```
+
### Starting the server
Database migration is required during the first server initialization. In addition, re-running the migration command might be needed in a new release to apply the new schema changes (if any). It's safer to always re-run the migration script before deploying/starting a new release.
To initialize the database schema, Run Migrations with the following command:
+
```bash
$ compass server migrate
```
@@ -106,14 +112,15 @@ $ compass server start
#### Using `--config` flag
```bash
-$ compass server migrate --config=
+$ compass server migrate --config=
```
```bash
$ compass server start --config=
```
-## Using the Docker
+## Using the Docker
+
To run the Compass server using Docker, you need to have Docker installed on your system. You can find the installation instructions [here](https://docs.docker.com/get-docker/).
You can choose to set the configuration using environment variables or a config file. The environment variables will override the config file.
@@ -125,9 +132,11 @@ Go to the root of this project and run `docker-compose`.
```bash
$ docker-compose up
```
+
Once postgres and elasticsearch has been ready, we can run Compass by passing in the config of postgres and elasticsearch defined in `docker-compose.yaml` file.
### Using config file
+
Alternatively you can use the `compass.yaml` config file defined [above](#using-config-file) and run the following command.
```bash
@@ -136,7 +145,7 @@ $ docker run -d \
-p 8080:8080 \
-v $(pwd)/compass.yaml:/compass.yaml \
--name compass-server \
- odpf/compass: \
+ raystack/compass: \
server start -c /compass.yaml
```
@@ -152,25 +161,27 @@ $ docker run -d \
-p 8080:8080 \
--env-file .env \
--name compass-server \
- odpf/compass: \
+ raystack/compass: \
server start
```
## Using the Helm chart
### Pre-requisites for Helm chart
-Compass can be installed in Kubernetes using the Helm chart from https://github.com/odpf/charts.
+
+Compass can be installed in Kubernetes using the Helm chart from https://github.com/raystack/charts.
Ensure that the following requirements are met:
+
- Kubernetes 1.14+
- Helm version 3.x is [installed](https://helm.sh/docs/intro/install/)
-### Add ODPF Helm repository
+### Add Raystack Helm repository
-Add ODPF chart repository to Helm:
+Add Raystack chart repository to Helm:
```
-helm repo add odpf https://odpf.github.io/charts/
+helm repo add raystack https://raystack.github.io/charts/
```
You can update the chart repository by running:
@@ -183,12 +194,12 @@ helm repo update
The following table lists the configurable parameters of the Compass chart and their default values.
-See full helm values guide [here](https://github.com/odpf/charts/tree/main/stable/compass#values)
+See full helm values guide [here](https://github.com/raystack/charts/tree/main/stable/compass#values)
```yaml title="values.yaml"
app:
image:
- repository: odpf/compass
+ repository: raystack/compass
pullPolicy: Always
tag: "0.3.0"
container:
@@ -240,7 +251,8 @@ app:
# COMPASS_NEWRELIC_APPNAME: compass
# COMPASS_LOG_LEVEL: info
- secretConfig: {}
+ secretConfig:
+ {}
# COMPASS_ELASTICSEARCH_BROKERS: ~
# COMPASS_STATSD_ADDRESS: ~
# COMPASS_NEWRELIC_LICENSEKEY: ~
@@ -255,27 +267,28 @@ app:
And install it with the helm command line along with the values file:
```bash
-$ helm install my-release -f values.yaml odpf/compass
+$ helm install my-release -f values.yaml raystack/compass
```
## Client Initialisation
-Add client configurations in the same `~/compass.yaml` file in root of current directory. Open this file to configure client.
+Add client configurations in the same `~/compass.yaml` file in root of current directory. Open this file to configure client.
```yml
client:
- host: localhost:8081
- serverheaderkey_uuid: Compass-User-UUID
- serverheadervalue_uuid: john.doe@example.com
+ host: localhost:8081
+ serverheaderkey_uuid: Compass-User-UUID
+ serverheadervalue_uuid: john.doe@example.com
```
#### Required Header/Metadata in API
+
Compass has a concept of [User](./concepts/user.md). In the current version, all HTTP & gRPC APIs in Compass requires an identity header/metadata in the request. The header key is configurable but the default name is `Compass-User-UUID`.
Compass APIs also expect an additional optional e-mail header. This is also configurable and the default name is `Compass-User-Email`. The purpose of having this optional e-mail header is described in the [User](./concepts/user.md) section.
-
If everything goes ok, you should see something like this:
+
```bash
time="2022-04-27T09:18:08Z" level=info msg="compass starting" version=v0.2.0
time="2022-04-27T09:18:08Z" level=info msg="connected to elasticsearch cluster" config="\"docker-cluster\" (server version 7.6.1)"
@@ -284,4 +297,3 @@ time="2022-04-27T09:18:08Z" level=info msg="statsd metrics monitoring is disable
time="2022-04-27T09:18:08Z" level=info msg="connected to postgres server" host=postgres port=5432
time="2022-04-27T09:18:08Z" level=info msg="server started"
```
-
diff --git a/docs/docs/guides/discussion.md b/docs/docs/guides/discussion.md
index 87458f68..992a09e8 100644
--- a/docs/docs/guides/discussion.md
+++ b/docs/docs/guides/discussion.md
@@ -7,7 +7,7 @@ Discussion is a new feature in Compass. One could create a discussion and all us
## Create a Discussion
-A discussion thread can be created with the Discussion API. The API contract is available [here](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
+A discussion thread can be created with the Discussion API. The API contract is available [here](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
@@ -23,18 +23,20 @@ $ compass discussion post --body=
"type": "openended"
}
```
+
```bash
$ curl --request POST 'http://localhost:8080/v1beta1/discussions' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"title": "The first discussion",
"body": "This is the first discussion thread in Compass",
"type": "openended"
}'
```
+
@@ -48,17 +50,20 @@ The Get Discussions will fetch all discussions in Compass.
```bash
$ compass discussion list
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/discussions' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
The response will be something like
+
```javascript
{
"data": [
@@ -73,7 +78,7 @@ The response will be something like
"assignees": [],
"owner": {
"id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
- "email": "odpf@email.com",
+ "email": "raystack@email.com",
"provider": "shield"
},
"created_at": "elit cillum Duis",
@@ -82,6 +87,7 @@ The response will be something like
]
}
```
+
Notice the state is `open` by default once we create a new discussion. There are also some additional features in discussion where we can label the discussion and assign users and assets to the discussion. These labelling and assinging assets and users could also be done when we are creating a discussion.
## Patching Discussion
@@ -90,7 +96,7 @@ If we are not labelling and assigning users & assets to the discussion in the cr
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/discussions/1' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"title": "The first discussion (duplicated)",
"state": "closed"
@@ -100,9 +106,10 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/discussions/1' \
We just need to send the fields that we want to patch for a discussion. Some fields have array type, in this case the PATCH will overwrite the fields with the new value.
For example we have this labelled discussion.
+
```bash
$ curl 'http://localhost:8080/v1beta1/discussions' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
{
"data": [
@@ -119,7 +126,7 @@ $ curl 'http://localhost:8080/v1beta1/discussions' \
],
"owner": {
"id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
- "email": "odpf@email.com",
+ "email": "raystack@email.com",
"provider": "shield"
},
"created_at": "elit cillum Duis",
@@ -133,16 +140,17 @@ If we patch the label with the new values.
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/discussions/1' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"labels": ["new value"]
}'
```
The discussion with id 1 will be updated like this.
+
```bash
$ curl 'http://localhost:8080/v1beta1/discussions' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
{
"data": [
@@ -157,7 +165,7 @@ $ curl 'http://localhost:8080/v1beta1/discussions' \
],
"owner": {
"id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
- "email": "odpf@email.com",
+ "email": "raystack@email.com",
"provider": "shield"
},
"created_at": "elit cillum Duis",
@@ -173,7 +181,7 @@ One could also comment a specific discussion with discussion comment API.
```bash
$ curl --request POST 'http://localhost:8080/v1beta1/discussions/1/comments' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"body": "This is the first comment of discussion 1"
}'
@@ -182,9 +190,10 @@ $ curl --request POST 'http://localhost:8080/v1beta1/discussions/1/comments' \
## Getting All My Discussions
Compass integrates discussions with User API so we could fetch all discussions belong to us with this API.
+
```bash
$ curl 'http://localhost:8080/v1beta1/me/discussions' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
{
"data": [
@@ -199,7 +208,7 @@ $ curl 'http://localhost:8080/v1beta1/me/discussions' \
],
"owner": {
"id": "dd9e2e07-a13f-1c2b-07e3-e32cf0f7688c",
- "email": "odpf@email.com",
+ "email": "raystack@email.com",
"provider": "shield"
},
"created_at": "elit cillum Duis",
@@ -207,4 +216,4 @@ $ curl 'http://localhost:8080/v1beta1/me/discussions' \
}
]
}
-```
\ No newline at end of file
+```
diff --git a/docs/docs/guides/ingestion.md b/docs/docs/guides/ingestion.md
index 444c0157..127c3c2f 100644
--- a/docs/docs/guides/ingestion.md
+++ b/docs/docs/guides/ingestion.md
@@ -11,7 +11,7 @@ This guide assumes that you have a local instance of compass running and listeni
## Adding Data
-Let’s say that you have a hypothetical tool called Piccolo and you have several deployments of this tool on your platform. Before we can push data for Piccolo deployments to Compass, you need to recognize the type of Piccolo, whether it is a kind of `table`, `topic`, `dashboard`, or `job`. One can ingest metadata to compass with the Upsert Patch API. The API contract is available [here](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
+Let’s say that you have a hypothetical tool called Piccolo and you have several deployments of this tool on your platform. Before we can push data for Piccolo deployments to Compass, you need to recognize the type of Piccolo, whether it is a kind of `table`, `topic`, `dashboard`, or `job`. One can ingest metadata to compass with the Upsert Patch API. The API contract is available [here](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
If there is an existing asset, Upsert Patch API will check each field whether there is an update in the field of the existing asset. With this behaviour, it is possible to send partial updated field to update a certain field only as long as the `urn`, `type`, and `service` match with the existing asset. If there is any field changed, a new version of the asset will be created. If the asset does not exist, upsert patch API will create a new asset. Apart from asset details, we also could send upstreams and downstreams of lineage edges of the asset in the body.
@@ -22,7 +22,7 @@ Let's say `piccolo` tool is a kind of `table`, we can start pushing data for it.
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-01",
@@ -39,12 +39,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
}
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-02",
@@ -61,12 +62,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
}
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-03",
@@ -83,6 +85,7 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
}
}'
```
+
@@ -101,12 +104,13 @@ Now we're ready to start searching. Let's run a search for the term **'one'** fr
```bash
$ compass search one
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text\=one' \
---header 'Compass-User-UUID:odpf@email.com' | jq
+--header 'Compass-User-UUID:raystack@email.com' | jq
```
@@ -116,36 +120,36 @@ The output is the following:
```json
{
- "data": [
- {
- "urn": "picollo:deployment-01",
- "type": "table",
- "name": "deployment-01",
- "service": "picollo",
- "description": "this is the one",
- "data": {},
- "owners": [
- {
- "email": "john.doe@email.com"
- }
- ],
- "labels": {}
- },
+ "data": [
+ {
+ "urn": "picollo:deployment-01",
+ "type": "table",
+ "name": "deployment-01",
+ "service": "picollo",
+ "description": "this is the one",
+ "data": {},
+ "owners": [
{
- "urn": "picollo:deployment-03",
- "type": "table",
- "name": "deployment-03",
- "service": "picollo",
- "description": "the last one",
- "data": {},
- "owners": [
- {
- "email": "kami@email.com"
- }
- ],
- "labels": {}
+ "email": "john.doe@email.com"
}
- ]
+ ],
+ "labels": {}
+ },
+ {
+ "urn": "picollo:deployment-03",
+ "type": "table",
+ "name": "deployment-03",
+ "service": "picollo",
+ "description": "the last one",
+ "data": {},
+ "owners": [
+ {
+ "email": "kami@email.com"
+ }
+ ],
+ "labels": {}
+ }
+ ]
}
```
@@ -154,7 +158,7 @@ The search is run against ALL fields of the records. It can be further restricte
#### We can search with custom queries in the following ways:
1. Using **`compass search --query=field_key1:val1`** CLI command
-2. Calling to **`GET /v1beta1/search`** API with `text` and `query[field_key1]=val1` as query parameters
+2. Calling to **`GET /v1beta1/search`** API with `text` and `query[field_key1]=val1` as query parameters
@@ -162,13 +166,15 @@ The search is run against ALL fields of the records. It can be further restricte
```bash
$ compass search one --query=owners:kami
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=one&query[owners]=kami' \
---header 'Compass-User-UUID:odpf@email.com' | jq
+--header 'Compass-User-UUID:raystack@email.com' | jq
```
+
@@ -176,22 +182,22 @@ The output is the following:
```json
{
- "data": [
+ "data": [
+ {
+ "urn": "picollo:deployment-03",
+ "type": "table",
+ "name": "deployment-03",
+ "service": "picollo",
+ "description": "the last one",
+ "data": {},
+ "owners": [
{
- "urn": "picollo:deployment-03",
- "type": "table",
- "name": "deployment-03",
- "service": "picollo",
- "description": "the last one",
- "data": {},
- "owners": [
- {
- "email": "kami@email.com"
- }
- ],
- "labels": {}
+ "email": "kami@email.com"
}
- ]
+ ],
+ "labels": {}
+ }
+ ]
}
```
@@ -202,12 +208,13 @@ Now that we have configured the `piccolo` type and learnt how to use the search
To begin with, let's start over adding picolo metadata with its lineage information and add another metadata with service name `sensu` and type `topic` and add some records for it.
### Adding `picollo` Metadata
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-01",
@@ -238,12 +245,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
]
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-02",
@@ -274,12 +282,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
]
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "picollo:deployment-03",
@@ -310,10 +319,12 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
]
}'
```
+
### Adding `sensu` Metadata
+
`sensu` is the data store that `piccolo` instances read from. In order to have a lineage, we need to have the metadata urn of `sensu` in Compass.
For instance, if you look at the `upstreams` and `downstreams` fields when we are ingesting `piccolo` metadata, you'll see that they are urn's of `sensu` instances. This means we can define the relationship between `piccolo` and `sensu` resources by declaring this relationship in `piccolo`'s definition.
@@ -322,7 +333,7 @@ For instance, if you look at the `upstreams` and `downstreams` fields when we ar
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "sensu:deployment-01",
@@ -336,12 +347,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
"downstreams": []
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "sensu:deployment-02",
@@ -355,12 +367,13 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
"downstreams": []
}'
```
+
```bash
$ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
---header 'Compass-User-UUID:odpf@email.com' \
+--header 'Compass-User-UUID:raystack@email.com' \
--data-raw '{
"asset": {
"urn": "sensu:deployment-03",
@@ -393,13 +406,15 @@ $ curl --request PATCH 'http://localhost:8080/v1beta1/assets' \
```bash
$ compass lineage picollo:deployment-01
```
+
```bash
curl 'http://localhost:8080/v1beta1/lineage/picollo%3Adeployment-01' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
@@ -407,23 +422,23 @@ The output is the following:
```json
{
- "data": [
- {
- "source": "sensu:deployment-01",
- "target": "picollo:deployment-01",
- "prop": {
- "root": "picollo:deployment-01"
- }
- },
- {
- "source": "picollo:deployment-01",
- "target": "gohan:deployment-01",
- "prop": {
- "root": "picollo:deployment-01"
- }
- }
- ],
- "node_attrs": {}
+ "data": [
+ {
+ "source": "sensu:deployment-01",
+ "target": "picollo:deployment-01",
+ "prop": {
+ "root": "picollo:deployment-01"
+ }
+ },
+ {
+ "source": "picollo:deployment-01",
+ "target": "gohan:deployment-01",
+ "prop": {
+ "root": "picollo:deployment-01"
+ }
+ }
+ ],
+ "node_attrs": {}
}
```
diff --git a/docs/docs/guides/querying.md b/docs/docs/guides/querying.md
index f0d4d1d9..298dc592 100644
--- a/docs/docs/guides/querying.md
+++ b/docs/docs/guides/querying.md
@@ -1,11 +1,12 @@
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
-# Querying metadata
+# Querying metadata
## Prerequisites
This guide assumes that you have a local instance of compass running and listening on `localhost:8080`. See [Installation](installation.md) guide for information on how to run Compass.
+
## Using the Search API
#### We can search for required text in the following ways:
@@ -13,7 +14,7 @@ This guide assumes that you have a local instance of compass running and listeni
1. Using **`compass search `** CLI command
2. Calling to **`GET /v1beta1/search`** API with `text` to be searched as query parameter
-The API contract is available [here](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
+The API contract is available [here](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
To demonstrate how to use compass, we’re going to query it for resources that contain the word ‘booking’.
@@ -23,13 +24,15 @@ To demonstrate how to use compass, we’re going to query it for resources that
```bash
$ compass search booking
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=booking' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
@@ -82,27 +85,30 @@ Compass decouple identifier from external system with the one that is being used
### Filter
-Compass search supports restricting search results via filter by passing it in query params. Filter query params format is **`filter[{field_key}]={value}`** where **`field_key`** is the field name that we want to restrict and **`value`** is what value that should be matched. Filter can also support nested field by chaining key **`field_key`** with **`.`** \(dot\) such as **`filter[{field_key}.{nested_field_key}]={value}`**.
+Compass search supports restricting search results via filter by passing it in query params. Filter query params format is **`filter[{field_key}]={value}`** where **`field_key`** is the field name that we want to restrict and **`value`** is what value that should be matched. Filter can also support nested field by chaining key **`field_key`** with **`.`** \(dot\) such as **`filter[{field_key}.{nested_field_key}]={value}`**.
+
#### We can filter our search in the following ways:
1. Using **`compass search --filter=field_key1:val1`** CLI command
-2. Calling to **`GET /v1beta1/search`** API with **`text`** and **`filter[field_key1]=val1`** as query parameters
+2. Calling to **`GET /v1beta1/search`** API with **`text`** and **`filter[field_key1]=val1`** as query parameters
-For instance, to restrict search results to the ‘id’ landscape for ‘odpf’ organisation, run:
+For instance, to restrict search results to the ‘id’ landscape for ‘raystack’ organisation, run:
```bash
-$ compass search booking --filter=labels.landscape=id,labels.entity=odpf
+$ compass search booking --filter=labels.landscape=id,labels.entity=raystack
```
+
```bash
-$ curl 'http://localhost:8080/v1beta1/search?text=booking&filter[labels.landscape]=id&filter[labels.entity]=odpf' \
---header 'Compass-User-UUID:odpf@email.com'
+$ curl 'http://localhost:8080/v1beta1/search?text=booking&filter[labels.landscape]=id&filter[labels.entity]=raystack' \
+--header 'Compass-User-UUID:raystack@email.com'
```
+
@@ -114,23 +120,26 @@ Under the hood, filter's work by checking whether the matching document's contai
```bash
$ compass search booking --filter=labels.landscape=vn,labels.landscape=th
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=booking&filter[labels.landscape]=vn&filter[labels.landscape]=th' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
### Query
Apart from filters, Compass search API also supports fuzzy restriction in its query params. The difference of filter and query are, filter is for exact match on a specific field in asset while query is for fuzzy match.
+
#### We can search with custom queries in the following ways:
1. Using **`compass search --query=field_key1:val1`** CLI command
-2. Calling to **`GET /v1beta1/search`** API with **`text`** and **`query[field_key1]=val1`** as query parameters
+2. Calling to **`GET /v1beta1/search`** API with **`text`** and **`query[field_key1]=val1`** as query parameters
Query format is not different with filter `query[{field_key}]={value}` where `field_key` is the field name that we want to query and `value` is what value that should be fuzzy matched. Query could also support nested field by chaining key `field_key` with `.` \(dot\) such as `query[{field_key}.{nested_field_key}]={value}`. For instance, to search results that has a name `kafka` and belongs to the team `data_engineering`, run:
@@ -140,17 +149,20 @@ Query format is not different with filter `query[{field_key}]={value}` where `fi
```bash
$ compass search booking --query=name:kafka,labels.team=data_eng
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=booking&query[name]=kafka&query[labels.team]=data_eng' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
### Ranking Results
+
Compass allows user to rank the results based on a numeric field in the asset. It supports nested field by using the `.` \(dot\) to point to the nested field. For instance, to rank the search results based on `usage_count` in `data` field, run:
@@ -159,17 +171,20 @@ Compass allows user to rank the results based on a numeric field in the asset. I
```bash
$ compass search booking --rankby=data.usage_count
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=booking&rankby=data.usage_count' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
### Size
+
You can also specify the number of maximum results you want compass to return using the **`size`** parameter
@@ -178,27 +193,31 @@ You can also specify the number of maximum results you want compass to return us
```bash
$ compass search booking --size=5
```
+
```bash
$ curl 'http://localhost:8080/v1beta1/search?text=booking&size=5' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
## Using the Suggest API
+
The Suggest API gives a number of suggestion based on asset's name. There are 5 suggestions by default return by this API.
-The API contract is available [here](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
+The API contract is available [here](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
Example of searching assets suggestion that has a name ‘booking’.
```bash
$ curl 'http://localhost:8080/v1beta1/search/suggest?text=booking' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
This will return a list of suggestions. Here’s a sample response:
```bash
@@ -212,27 +231,27 @@ This will return a list of suggestions. Here’s a sample response:
]
}
```
-## Using the Get Assets API
-The Get Assets API returns assets from Compass' main storage (PostgreSQL) while the Search API returns assets from Elasticsearch. The Get Assets API has several options (filters, size, offset, etc...) in its query params.
+## Using the Get Assets API
-| Query Params | Description |
-|---|---|
-|`types=topic,table`| filter by types |
-|`services=kafka,postgres`| filter by services |
-|`data[dataset]=booking&data[project]=p-godata-id`| filter by field in asset.data |
-|`q=internal&q_fields=name,urn,description,services`| querying by field|
-|`sort=created_at`|sort by certain fields|
-|`direction=desc`|sorting direction (asc / desc)|
+The Get Assets API returns assets from Compass' main storage (PostgreSQL) while the Search API returns assets from Elasticsearch. The Get Assets API has several options (filters, size, offset, etc...) in its query params.
+| Query Params | Description |
+| --------------------------------------------------- | ------------------------------ |
+| `types=topic,table` | filter by types |
+| `services=kafka,postgres` | filter by services |
+| `data[dataset]=booking&data[project]=p-godata-id` | filter by field in asset.data |
+| `q=internal&q_fields=name,urn,description,services` | querying by field |
+| `sort=created_at` | sort by certain fields |
+| `direction=desc` | sorting direction (asc / desc) |
-The API contract is available [here](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
+The API contract is available [here](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json).
## Using the Lineage API
The Lineage API allows the clients to query the data flow relationship between different assets managed by Compass.
-See the swagger definition of [Lineage API](https://github.com/odpf/compass/blob/main/third_party/OpenAPI/compass.swagger.json)) for more information.
+See the swagger definition of [Lineage API](https://github.com/raystack/compass/blob/main/third_party/OpenAPI/compass.swagger.json)) for more information.
Lineage API returns a list of directed edges. For each edge, there are `source` and `target` fields that represent nodes to indicate the direction of the edge. Each edge could have an optional property in the `props` field.
@@ -247,50 +266,50 @@ Lineage API returns a list of directed edges. For each edge, there are `source`
```bash
$ compass lineage data-project:datalake.events
```
+
-
```bash
$ curl 'http://localhost:8080/v1beta1/lineage/data-project%3Adatalake.events' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
+
```json
{
- "data": [
- {
- "source": {
- "urn": "data-project:datalake.events",
- "type": "table",
- "service": "bigquery",
- },
- "target": {
- "urn": "events-transform-dwh",
- "type": "csv",
- "service": "s3",
- },
- "props": {}
- },
- {
- "source": {
- "urn": "events-ingestion",
- "type": "topic",
- "service": "beast",
- },
- "target": {
- "urn": "data-project:datalake.events",
- "type": "table",
- "service": "bigquery",
- },
- "props": {}
- },
- ]
+ "data": [
+ {
+ "source": {
+ "urn": "data-project:datalake.events",
+ "type": "table",
+ "service": "bigquery"
+ },
+ "target": {
+ "urn": "events-transform-dwh",
+ "type": "csv",
+ "service": "s3"
+ },
+ "props": {}
+ },
+ {
+ "source": {
+ "urn": "events-ingestion",
+ "type": "topic",
+ "service": "beast"
+ },
+ "target": {
+ "urn": "data-project:datalake.events",
+ "type": "table",
+ "service": "bigquery"
+ },
+ "props": {}
+ }
+ ]
}
```
The lineage is fetched from the perspective of an asset. The response shows it has a list of upstreams and downstreams assets of the requested asset.
Notice that in the URL, we are using `urn` instead of `id`. The reason is because we use `urn` as a main identifier in our lineage storage. We don't use `id` to store the lineage as a main identifier, because `id` is internally auto generated and in lineage, there might be some assets that we don't store in our Compass' storage yet.
-
diff --git a/docs/docs/guides/starring.md b/docs/docs/guides/starring.md
index 607c56c7..0a79fd67 100644
--- a/docs/docs/guides/starring.md
+++ b/docs/docs/guides/starring.md
@@ -1,18 +1,19 @@
# Starring
-Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information.
+Compass allows a user to stars an asset. This bookmarking functionality is introduced to increase the speed of a user to get information.
To star and asset, we can use the User Starring API. Assuming we already have `asset_id` that we want to star.
```bash
$ curl --request PUT 'http://localhost:8080/v1beta1/me/starred/00c06ef7-badb-4236-9d9e-889697cbda46' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
```
To get the list of my starred assets.
+
```bash
$ curl --request PUT 'http://localhost:8080/v1beta1/me/starred' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
{
"data": [
@@ -36,15 +37,15 @@ There is also an API to see which users star an asset (stargazers) in the Asset
```bash
$ curl 'http://localhost:8080/v1beta1/assets/00c06ef7-badb-4236-9d9e-889697cbda46/stargazers' \
---header 'Compass-User-UUID:odpf@email.com'
+--header 'Compass-User-UUID:raystack@email.com'
{
"data": [
{
"id": "1111-2222-3333",
- "email": "odpf@email.com",
+ "email": "raystack@email.com",
"provider": "shield"
}
]
}
-```
\ No newline at end of file
+```
diff --git a/docs/docs/guides/tagging.md b/docs/docs/guides/tagging.md
index bb95e772..8aa4ff3c 100644
--- a/docs/docs/guides/tagging.md
+++ b/docs/docs/guides/tagging.md
@@ -3,13 +3,14 @@
This doc explains how to tag an asset in Compass with a specific tag.
## Tag Template
+
To support reusability of a tag, Compass has a tag template that we need to define first before we apply it to an asset. Tagging an asset means Compass will wire tag template to assets.
Creating a tag's template could be done with Tag Template API.
```bash
$ curl --request POST 'localhost:8080/v1beta1/tags/templates' \
---header 'Compass-User-UUID: user@odpf.io' \
+--header 'Compass-User-UUID: user@raystack.io' \
--data-raw '{
"urn": "my-first-template",
"display_name": "My First Template",
@@ -37,9 +38,11 @@ We can verify the tag's template is created by calling GET tag's templates API
```bash
$ curl --request GET 'localhost:8080/v1beta1/tags/templates' \
---header 'Compass-User-UUID: user@odpf.io'
+--header 'Compass-User-UUID: user@raystack.io'
```
+
The response will be like this
+
```javascript
{
"data": [
@@ -76,10 +79,13 @@ The response will be like this
```
Now, we already have a template with template urn `my-first-template` that has 2 kind of fields with id `1` and `2`.
+
## Tagging an Asset
+
Once templates exist, we can tag an asset with a template by calling PUT `/v1beta1/tags/assets/{asset_id}` API.
Assuming we have an asset
+
```javascript
{
"id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
@@ -90,7 +96,7 @@ Assuming we have an asset
"description": "sample description",
"version": "0.1",
"updated_by": {
- "uuid": "user@odpf.io"
+ "uuid": "user@raystack.io"
},
"created_at": "2022-05-11T07:03:45.954387Z",
"updated_at": "2022-05-11T07:03:45.954387Z"
@@ -98,9 +104,10 @@ Assuming we have an asset
```
We can tag the asset with template `my-first-template`.
+
```bash
$ curl --request POST 'localhost:8080/v1beta1/tags/assets' \
---header 'Compass-User-UUID: user@odpf.io'
+--header 'Compass-User-UUID: user@raystack.io'
--data-raw '{
"asset_id": "a2c74793-b584-4d20-ba2a-28bdf6b92c08",
"template_urn": "my-first-template",
@@ -118,6 +125,7 @@ $ curl --request POST 'localhost:8080/v1beta1/tags/assets' \
```
We will get response showing that the asset is already tagged.
+
```javascript
{
"data": {
@@ -150,14 +158,15 @@ We will get response showing that the asset is already tagged.
"template_description": "This is my first template"
}
}
-```
+```
## Getting Asset's Tag(s)
+
We can get all tags belong to an asset by calling GET `/v1beta1/tags/assets/{asset_id}` API.
```bash
$ curl --request GET 'localhost:8080/v1beta1/tags/assets/a2c74793-b584-4d20-ba2a-28bdf6b92c08' \
---header 'Compass-User-UUID: user@odpf.io'
+--header 'Compass-User-UUID: user@raystack.io'
{
"data": [
@@ -191,4 +200,5 @@ $ curl --request GET 'localhost:8080/v1beta1/tags/assets/a2c74793-b584-4d20-ba2a
"template_description": "This is my first template"
}
]
-}
\ No newline at end of file
+}
+```
diff --git a/docs/docs/installation.md b/docs/docs/installation.md
index 4cd52c28..9c7e4083 100644
--- a/docs/docs/installation.md
+++ b/docs/docs/installation.md
@@ -8,16 +8,16 @@ There are several approaches to install Compass.
### Binary (Cross-platform)
-Download the appropriate version for your platform from [releases](https://github.com/odpf/compass/releases) page. Once downloaded, the binary can be run from anywhere.
+Download the appropriate version for your platform from [releases](https://github.com/raystack/compass/releases) page. Once downloaded, the binary can be run from anywhere.
You don’t need to install it into a global location. This works well for shared hosts and other systems where you don’t have a privileged account.
Ideally, you should install it somewhere in your PATH for easy use. `/usr/local/bin` is the most probable location.
#### macOS
-`Compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/odpf/compass/releases) page:
+`Compass` is available via a Homebrew Tap, and as downloadable binary from the [releases](https://github.com/raystack/compass/releases) page:
```sh
-brew install odpf/tap/compass
+brew install raystack/tap/compass
```
To upgrade to the latest version:
@@ -28,14 +28,14 @@ brew upgrade compass
#### Linux
-`Compass` is available as downloadable binaries from the [releases](https://github.com/odpf/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
+`Compass` is available as downloadable binaries from the [releases](https://github.com/raystack/compass/releases/latest) page. Download the `.deb` or `.rpm` from the releases page and install with `sudo dpkg -i` and `sudo rpm -i` respectively.
#### Windows
-`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/odpf/compass/releases/latest) page:
+`compass` is available via [scoop](https://scoop.sh/), and as a downloadable binary from the [releases](https://github.com/raystack/compass/releases/latest) page:
```
-scoop bucket add compass https://github.com/odpf/scoop-bucket.git
+scoop bucket add compass https://github.com/raystack/scoop-bucket.git
```
To upgrade to the latest version:
@@ -49,35 +49,36 @@ scoop update compass
We provide ready to use Docker container images. To pull the latest image:
```
-docker pull odpf/compass:latest
+docker pull raystack/compass:latest
```
To pull a specific version:
```
-docker pull odpf/compass:v0.3.2
+docker pull raystack/compass:v0.3.2
```
If you like to have a shell alias that runs the latest version of compass from docker whenever you type `compass`:
```
-mkdir -p $HOME/.config/odpf
-alias compass="docker run -e HOME=/tmp -v $HOME/.config/odpf:/tmp/.config/odpf --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp odpf/compass:latest"
+mkdir -p $HOME/.config/raystack
+alias compass="docker run -e HOME=/tmp -v $HOME/.config/raystack:/tmp/.config/raystack --user $(id -u):$(id -g) --rm -it -p 3306:3306/tcp raystack/compass:latest"
```
### Building from Source
Begin by cloning this repository then you have two ways in which you can build compass
-* As a native executable
-* As a docker image
+- As a native executable
+- As a docker image
Run either of the following commands to clone and compile Compass from source
```bash
-$ git clone git@github.com:odpf/compass.git # (Using SSH Protocol)
-$ git clone https://github.com/odpf/compass.git # (Using HTTPS Protocol)
+$ git clone git@github.com:raystack/compass.git # (Using SSH Protocol)
+$ git clone https://github.com/raystack/compass.git # (Using HTTPS Protocol)
```
+
#### As a native executable
To build compass as a native executable, run `make` inside the cloned repository.
diff --git a/docs/docs/introduction.md b/docs/docs/introduction.md
index 2188db05..6b8771d0 100644
--- a/docs/docs/introduction.md
+++ b/docs/docs/introduction.md
@@ -34,7 +34,9 @@ Discover why users choose Compass as their main data discovery and lineage servi
- **Runtime:** Compass can run inside VMs or containers in a fully managed runtime environment like kubernetes.
## Using Compass
+
You can manage the data discovery for your resources via Compass in any of the following ways:
+
### Compass Command Line Interface
You can use the Compass command line interface to issue commands and to perform the entire data discovery flow. Using the command line can be faster and more convenient than the console. For more information on using the Compass CLI, see the [CLI Reference](./reference/cli.md) page.
@@ -50,4 +52,4 @@ See the [installation](./installation) page to install the Compass CLI. Next, we
After completing the tour, check out the remainder of the documentation in the reference and concepts sections for your specific areas of interest. We've aimed to provide as much documentation as we can for the various components of Compass to give you a full understanding of Compass's surface area.
-Finally, follow the project on [GitHub](https://github.com/odpf/compass), and contact us if you'd like to get involved.
\ No newline at end of file
+Finally, follow the project on [GitHub](https://github.com/raystack/compass), and contact us if you'd like to get involved.
diff --git a/docs/docs/reference/api.md b/docs/docs/reference/api.md
index 83b79f89..8f564910 100644
--- a/docs/docs/reference/api.md
+++ b/docs/docs/reference/api.md
@@ -1,17 +1,19 @@
# Compass
+
Documentation of our Compass API with gRPC and gRPC-Gateway.
## Version: 0.3.0
-**License:** [Apache License 2.0](https://github.com/odpf/compass/blob/main/LICENSE)
+**License:** [Apache License 2.0](https://github.com/raystack/compass/blob/main/LICENSE)
-[More about Compass](https://odpf.gitbook.io/compass/)
+[More about Compass](https://raystack.gitbook.io/compass/)
## default
### /v1beta1/assets
#### GET
+
##### Summary
Get list of assets
@@ -22,30 +24,31 @@ Returns list of assets, optionally filtered by types, services, sorting, fields
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| q | query | filter by specific query | No | string |
-| q_fields | query | filter by multiple query fields | No | string |
-| types | query | filter by multiple types | No | string |
-| services | query | filter by multiple services | No | string |
-| sort | query | sorting based on fields | No | string |
-| direction | query | sorting direction can either be asc or desc | No | string |
-| size | query | maximum size to fetch | No | long |
-| offset | query | offset to fetch from | No | long |
-| with_total | query | if set include total field in response | No | boolean |
+| Name | Located in | Description | Required | Schema |
+| ---------- | ---------- | ------------------------------------------- | -------- | ------- |
+| q | query | filter by specific query | No | string |
+| q_fields | query | filter by multiple query fields | No | string |
+| types | query | filter by multiple types | No | string |
+| services | query | filter by multiple services | No | string |
+| sort | query | sorting based on fields | No | string |
+| direction | query | sorting direction can either be asc or desc | No | string |
+| size | query | maximum size to fetch | No | long |
+| offset | query | offset to fetch from | No | long |
+| with_total | query | if set include total field in response | No | boolean |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllAssetsResponse](#getallassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------- |
+| 200 | A successful response. | [GetAllAssetsResponse](#getallassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update/Create an asset
@@ -56,22 +59,23 @@ Upsert will update an asset or create a new one if it does not exist yet
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | | Yes | [UpsertAssetRequest](#upsertassetrequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ----------------------------------------- |
+| body | body | | Yes | [UpsertAssetRequest](#upsertassetrequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpsertAssetResponse](#upsertassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------- |
+| 200 | A successful response. | [UpsertAssetResponse](#upsertassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PATCH
+
##### Summary
Patch/Create an asset
@@ -82,24 +86,25 @@ Similar to Upsert but with patch strategy and different body format
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | | Yes | [UpsertPatchAssetRequest](#upsertpatchassetrequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | --------------------------------------------------- |
+| body | body | | Yes | [UpsertPatchAssetRequest](#upsertpatchassetrequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpsertPatchAssetResponse](#upsertpatchassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------- |
+| 200 | A successful response. | [UpsertPatchAssetResponse](#upsertpatchassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/assets/{asset_urn}/probes
#### POST
+
##### Summary
Create asset's probe
@@ -110,25 +115,26 @@ Add a new probe to an asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_urn | path | | Yes | string |
-| probe | body | | Yes | [CreateAssetProbeRequest.Probe](#createassetproberequestprobe) |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | -------------------------------------------------------------- |
+| asset_urn | path | | Yes | string |
+| probe | body | | Yes | [CreateAssetProbeRequest.Probe](#createassetproberequestprobe) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateAssetProbeResponse](#createassetproberesponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------- |
+| 200 | A successful response. | [CreateAssetProbeResponse](#createassetproberesponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/assets/{id}
#### GET
+
##### Summary
Find an asset
@@ -141,20 +147,21 @@ Returns a single asset with given ID
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAssetByIDResponse](#getassetbyidresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------- |
+| 200 | A successful response. | [GetAssetByIDResponse](#getassetbyidresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Delete an asset
@@ -167,22 +174,23 @@ Delete a single asset with given ID
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [DeleteAssetResponse](#deleteassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------- |
+| 200 | A successful response. | [DeleteAssetResponse](#deleteassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/assets/{id}/stargazers
#### GET
+
##### Summary
Find users that stars an asset
@@ -193,26 +201,27 @@ Returns a list of users that stars an asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------ | ---------- | ----------- | -------- | ------ |
+| id | path | | Yes | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAssetStargazersResponse](#getassetstargazersresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------------- |
+| 200 | A successful response. | [GetAssetStargazersResponse](#getassetstargazersresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/assets/{id}/versions
#### GET
+
##### Summary
Get version history of an asset
@@ -223,26 +232,27 @@ Returns a list of asset version history
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------ | ---------- | ----------- | -------- | ------ |
+| id | path | | Yes | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAssetVersionHistoryResponse](#getassetversionhistoryresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------------------- |
+| 200 | A successful response. | [GetAssetVersionHistoryResponse](#getassetversionhistoryresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/assets/{id}/versions/{version}
#### GET
+
##### Summary
Get asset's previous version
@@ -253,25 +263,26 @@ Returns a specific version of an asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
-| version | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------- | ---------- | ----------- | -------- | ------ |
+| id | path | | Yes | string |
+| version | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAssetByVersionResponse](#getassetbyversionresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [GetAssetByVersionResponse](#getassetbyversionresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/lineage/{urn}
#### GET
+
##### Summary
Get Lineage Graph
@@ -282,26 +293,27 @@ Returns the lineage graph. Each entry in the graph describes a (edge) directed r
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| urn | path | | Yes | string |
-| level | query | | No | long |
-| direction | query | | No | string |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | ------ |
+| urn | path | | Yes | string |
+| level | query | | No | long |
+| direction | query | | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetGraphResponse](#getgraphresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------- |
+| 200 | A successful response. | [GetGraphResponse](#getgraphresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/search
#### GET
+
##### Summary
Search for an asset
@@ -312,28 +324,29 @@ API for querying documents. 'text' is fuzzy matched against all the available da
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| text | query | text to search for (fuzzy) | No | string |
-| rankby | query | descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]" | No | string |
-| size | query | number of results to return | No | long |
-| include_fields | query | | No | [ string ] |
-| offset | query | offset parameter defines the offset from the first result you want to fetch | No | long |
+| Name | Located in | Description | Required | Schema |
+| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------- |
+| text | query | text to search for (fuzzy) | No | string |
+| rankby | query | descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]" | No | string |
+| size | query | number of results to return | No | long |
+| include_fields | query | | No | [ string ] |
+| offset | query | offset parameter defines the offset from the first result you want to fetch | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [SearchAssetsResponse](#searchassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------- |
+| 200 | A successful response. | [SearchAssetsResponse](#searchassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/search/suggest
#### GET
+
##### Summary
Suggest an asset
@@ -344,204 +357,212 @@ API for retreiving N number of asset names that similar with the `text`. By defa
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| text | query | text to search for suggestions | No | string |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ------------------------------ | -------- | ------ |
+| text | query | text to search for suggestions | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [SuggestAssetsResponse](#suggestassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [SuggestAssetsResponse](#suggestassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/discussions
#### GET
+
##### Summary
Get all discussions
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| type | query | | No | string |
-| state | query | | No | string |
-| owner | query | | No | string |
-| assignee | query | | No | string |
-| asset | query | | No | string |
-| labels | query | | No | string |
-| sort | query | | No | string |
-| direction | query | | No | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | ------ |
+| type | query | | No | string |
+| state | query | | No | string |
+| owner | query | | No | string |
+| assignee | query | | No | string |
+| asset | query | | No | string |
+| labels | query | | No | string |
+| sort | query | | No | string |
+| direction | query | | No | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllDiscussionsResponse](#getalldiscussionsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [GetAllDiscussionsResponse](#getalldiscussionsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### POST
+
##### Summary
Create a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | Request to be sent to create a discussion | Yes | [CreateDiscussionRequest](#creatediscussionrequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------------------------------------- | -------- | --------------------------------------------------- |
+| body | body | Request to be sent to create a discussion | Yes | [CreateDiscussionRequest](#creatediscussionrequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateDiscussionResponse](#creatediscussionresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------- |
+| 200 | A successful response. | [CreateDiscussionResponse](#creatediscussionresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/discussions/{discussion_id}/comments
#### GET
+
##### Summary
Get all comments of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| sort | query | | No | string |
-| direction | query | | No | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| sort | query | | No | string |
+| direction | query | | No | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllCommentsResponse](#getallcommentsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [GetAllCommentsResponse](#getallcommentsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### POST
+
##### Summary
Create a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| body | body | | Yes | { **"body"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ---------------------- |
+| discussion_id | path | | Yes | string |
+| body | body | | Yes | { **"body"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateCommentResponse](#createcommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [CreateCommentResponse](#createcommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/discussions/{discussion_id}/comments/{id}
#### GET
+
##### Summary
Get a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetCommentResponse](#getcommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------- |
+| 200 | A successful response. | [GetCommentResponse](#getcommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Delete a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [DeleteCommentResponse](#deletecommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [DeleteCommentResponse](#deletecommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
-| body | body | | Yes | { **"body"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ---------------------- |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
+| body | body | | Yes | { **"body"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpdateCommentResponse](#updatecommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [UpdateCommentResponse](#updatecommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/discussions/{id}
#### GET
+
##### Summary
Get a discussion
@@ -550,45 +571,47 @@ Get a discussion
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetDiscussionResponse](#getdiscussionresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [GetDiscussionResponse](#getdiscussionresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PATCH
+
##### Summary
Patch a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| id | path | | Yes | string |
-| body | body | | Yes | { **"assets"**: [ string ], **"assignees"**: [ string ], **"body"**: string, **"labels"**: [ string ], **"state"**: string, **"title"**: string, **"type"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| id | path | | Yes | string |
+| body | body | | Yes | { **"assets"**: [ string ], **"assignees"**: [ string ], **"body"**: string, **"labels"**: [ string ], **"state"**: string, **"title"**: string, **"type"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [PatchDiscussionResponse](#patchdiscussionresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------- |
+| 200 | A successful response. | [PatchDiscussionResponse](#patchdiscussionresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/me/discussions
#### GET
+
##### Summary
Get all discussions of a user
@@ -599,159 +622,165 @@ Returns all discussions given possible filters of a user
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| filter | query | | No | string |
-| type | query | | No | string |
-| state | query | | No | string |
-| asset | query | | No | string |
-| labels | query | | No | string |
-| sort | query | | No | string |
-| direction | query | | No | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | ------ |
+| filter | query | | No | string |
+| type | query | | No | string |
+| state | query | | No | string |
+| asset | query | | No | string |
+| labels | query | | No | string |
+| sort | query | | No | string |
+| direction | query | | No | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyDiscussionsResponse](#getmydiscussionsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------- |
+| 200 | A successful response. | [GetMyDiscussionsResponse](#getmydiscussionsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/discussions/{discussion_id}/comments
#### GET
+
##### Summary
Get all comments of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| sort | query | | No | string |
-| direction | query | | No | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| sort | query | | No | string |
+| direction | query | | No | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllCommentsResponse](#getallcommentsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [GetAllCommentsResponse](#getallcommentsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### POST
+
##### Summary
Create a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| body | body | | Yes | { **"body"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ---------------------- |
+| discussion_id | path | | Yes | string |
+| body | body | | Yes | { **"body"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateCommentResponse](#createcommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [CreateCommentResponse](#createcommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/discussions/{discussion_id}/comments/{id}
#### GET
+
##### Summary
Get a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetCommentResponse](#getcommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------- |
+| 200 | A successful response. | [GetCommentResponse](#getcommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Delete a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ------ |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [DeleteCommentResponse](#deletecommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [DeleteCommentResponse](#deletecommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update a comment of a discussion
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| discussion_id | path | | Yes | string |
-| id | path | | Yes | string |
-| body | body | | Yes | { **"body"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ------------- | ---------- | ----------- | -------- | ---------------------- |
+| discussion_id | path | | Yes | string |
+| id | path | | Yes | string |
+| body | body | | Yes | { **"body"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpdateCommentResponse](#updatecommentresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [UpdateCommentResponse](#updatecommentresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/lineage/{urn}
#### GET
+
##### Summary
Get Lineage Graph
@@ -762,28 +791,29 @@ Returns the lineage graph. Each entry in the graph describes a (edge) directed r
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| urn | path | | Yes | string |
-| level | query | | No | long |
-| direction | query | | No | string |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | ------ |
+| urn | path | | Yes | string |
+| level | query | | No | long |
+| direction | query | | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetGraphResponse](#getgraphresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------- |
+| 200 | A successful response. | [GetGraphResponse](#getgraphresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/me/discussions
#### GET
+
##### Summary
Get all discussions of a user
@@ -794,32 +824,33 @@ Returns all discussions given possible filters of a user
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| filter | query | | No | string |
-| type | query | | No | string |
-| state | query | | No | string |
-| asset | query | | No | string |
-| labels | query | | No | string |
-| sort | query | | No | string |
-| direction | query | | No | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| --------- | ---------- | ----------- | -------- | ------ |
+| filter | query | | No | string |
+| type | query | | No | string |
+| state | query | | No | string |
+| asset | query | | No | string |
+| labels | query | | No | string |
+| sort | query | | No | string |
+| direction | query | | No | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyDiscussionsResponse](#getmydiscussionsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------------- |
+| 200 | A successful response. | [GetMyDiscussionsResponse](#getmydiscussionsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/me/starred
#### GET
+
##### Summary
Get my starred assets
@@ -830,25 +861,26 @@ Get all assets starred by me
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------ | ---------- | ----------- | -------- | ------ |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyStarredAssetsResponse](#getmystarredassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------------- |
+| 200 | A successful response. | [GetMyStarredAssetsResponse](#getmystarredassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/me/starred/{asset_id}
#### GET
+
##### Summary
Get my starred asset
@@ -859,22 +891,23 @@ Get an asset starred by me
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyStarredAssetResponse](#getmystarredassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [GetMyStarredAssetResponse](#getmystarredassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Unstar an asset
@@ -885,22 +918,23 @@ Unmark my starred asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UnstarAssetResponse](#unstarassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------- |
+| 200 | A successful response. | [UnstarAssetResponse](#unstarassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Star an asset
@@ -911,24 +945,25 @@ Mark an asset with a star
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [StarAssetResponse](#starassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------- |
+| 200 | A successful response. | [StarAssetResponse](#starassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/users/{user_id}/starred
#### GET
+
##### Summary
Get assets starred by a user
@@ -939,28 +974,29 @@ Get all assets starred by a user
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| user_id | path | | Yes | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------- | ---------- | ----------- | -------- | ------ |
+| user_id | path | | Yes | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetUserStarredAssetsResponse](#getuserstarredassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------------- |
+| 200 | A successful response. | [GetUserStarredAssetsResponse](#getuserstarredassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/me/starred
#### GET
+
##### Summary
Get my starred assets
@@ -971,25 +1007,26 @@ Get all assets starred by me
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------ | ---------- | ----------- | -------- | ------ |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyStarredAssetsResponse](#getmystarredassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------------- |
+| 200 | A successful response. | [GetMyStarredAssetsResponse](#getmystarredassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/me/starred/{asset_id}
#### GET
+
##### Summary
Get my starred asset
@@ -1000,22 +1037,23 @@ Get an asset starred by me
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetMyStarredAssetResponse](#getmystarredassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [GetMyStarredAssetResponse](#getmystarredassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Unstar an asset
@@ -1026,22 +1064,23 @@ Unmark my starred asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UnstarAssetResponse](#unstarassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------- |
+| 200 | A successful response. | [UnstarAssetResponse](#unstarassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Star an asset
@@ -1052,24 +1091,25 @@ Mark an asset with a star
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [StarAssetResponse](#starassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------- |
+| 200 | A successful response. | [StarAssetResponse](#starassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/users/{user_id}/starred
#### GET
+
##### Summary
Get assets starred by a user
@@ -1080,28 +1120,29 @@ Get all assets starred by a user
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| user_id | path | | Yes | string |
-| size | query | | No | long |
-| offset | query | | No | long |
+| Name | Located in | Description | Required | Schema |
+| ------- | ---------- | ----------- | -------- | ------ |
+| user_id | path | | Yes | string |
+| size | query | | No | long |
+| offset | query | | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetUserStarredAssetsResponse](#getuserstarredassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------------- |
+| 200 | A successful response. | [GetUserStarredAssetsResponse](#getuserstarredassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/namespaces
#### GET
+
##### Summary
List namespace
@@ -1112,16 +1153,17 @@ List all created namespaces
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [ListNamespacesResponse](#listnamespacesresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [ListNamespacesResponse](#listnamespacesresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### POST
+
##### Summary
Create a namespace
@@ -1132,24 +1174,25 @@ Create a new namespace, throws error if already exists
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | | Yes | [CreateNamespaceRequest](#createnamespacerequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ----------- | -------- | ------------------------------------------------- |
+| body | body | | Yes | [CreateNamespaceRequest](#createnamespacerequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateNamespaceResponse](#createnamespaceresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------- |
+| 200 | A successful response. | [CreateNamespaceResponse](#createnamespaceresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/namespaces/{urn}
#### GET
+
##### Summary
Get namespace
@@ -1160,22 +1203,23 @@ Fetch a namespace details, throws error if doesn't exists. Use id or name as urn
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| urn | path | set either id or name | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | --------------------- | -------- | ------ |
+| urn | path | set either id or name | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetNamespaceResponse](#getnamespaceresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------- |
+| 200 | A successful response. | [GetNamespaceResponse](#getnamespaceresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update namespace
@@ -1186,27 +1230,28 @@ Update an existing namespace, throws error if doesn't exists. Use id or name as
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| urn | path | set either id or name | Yes | string |
-| body | body | | Yes | { **"metadata"**: object, **"state"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | --------------------- | -------- | ----------------------------------------------- |
+| urn | path | set either id or name | Yes | string |
+| body | body | | Yes | { **"metadata"**: object, **"state"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpdateNamespaceResponse](#updatenamespaceresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------- |
+| 200 | A successful response. | [UpdateNamespaceResponse](#updatenamespaceresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/search
#### GET
+
##### Summary
Search for an asset
@@ -1217,28 +1262,29 @@ API for querying documents. 'text' is fuzzy matched against all the available da
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| text | query | text to search for (fuzzy) | No | string |
-| rankby | query | descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]" | No | string |
-| size | query | number of results to return | No | long |
-| include_fields | query | | No | [ string ] |
-| offset | query | offset parameter defines the offset from the first result you want to fetch | No | long |
+| Name | Located in | Description | Required | Schema |
+| -------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- | ---------- |
+| text | query | text to search for (fuzzy) | No | string |
+| rankby | query | descendingly sort based on a numeric field in the asset. the nested field is written with period separated field name. eg, "rankby[data.profile.usage_count]" | No | string |
+| size | query | number of results to return | No | long |
+| include_fields | query | | No | [ string ] |
+| offset | query | offset parameter defines the offset from the first result you want to fetch | No | long |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [SearchAssetsResponse](#searchassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------- |
+| 200 | A successful response. | [SearchAssetsResponse](#searchassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/search/suggest
#### GET
+
##### Summary
Suggest an asset
@@ -1249,26 +1295,27 @@ API for retreiving N number of asset names that similar with the `text`. By defa
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| text | query | text to search for suggestions | No | string |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ------------------------------ | -------- | ------ |
+| text | query | text to search for suggestions | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [SuggestAssetsResponse](#suggestassetsresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ----------------------------------------------- |
+| 200 | A successful response. | [SuggestAssetsResponse](#suggestassetsresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/tags/assets
#### POST
+
##### Summary
Tag an asset
@@ -1279,24 +1326,25 @@ Tag an asset with a tag template
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | Request to be sent to create a tag | Yes | [CreateTagAssetRequest](#createtagassetrequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | ---------------------------------- | -------- | ----------------------------------------------- |
+| body | body | Request to be sent to create a tag | Yes | [CreateTagAssetRequest](#createtagassetrequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateTagAssetResponse](#createtagassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [CreateTagAssetResponse](#createtagassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/tags/assets/{asset_id}
#### GET
+
##### Summary
Get an asset's tags
@@ -1307,24 +1355,25 @@ Get all tags for an assets
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllTagsByAssetResponse](#getalltagsbyassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [GetAllTagsByAssetResponse](#getalltagsbyassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/tags/assets/{asset_id}/templates/{template_urn}
#### GET
+
##### Summary
Find a tag by asset and template
@@ -1335,23 +1384,24 @@ Find a single tag using asset id and template urn
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
-| template_urn | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
+| template_urn | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetTagByAssetAndTemplateResponse](#gettagbyassetandtemplateresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------------------------- |
+| 200 | A successful response. | [GetTagByAssetAndTemplateResponse](#gettagbyassetandtemplateresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Remove a tag on an asset
@@ -1362,23 +1412,24 @@ Remove a tag on an asset in a type
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
-| template_urn | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------ |
+| asset_id | path | | Yes | string |
+| template_urn | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [DeleteTagAssetResponse](#deletetagassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [DeleteTagAssetResponse](#deletetagassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update a tag on an asset
@@ -1389,26 +1440,27 @@ Update a tag on an asset
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| asset_id | path | | Yes | string |
-| template_urn | path | | Yes | string |
-| body | body | | Yes | { **"tag_values"**: [ [TagValue](#tagvalue) ], **"template_description"**: string, **"template_display_name"**: string } |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| asset_id | path | | Yes | string |
+| template_urn | path | | Yes | string |
+| body | body | | Yes | { **"tag_values"**: [ [TagValue](#tagvalue) ], **"template_description"**: string, **"template_display_name"**: string } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpdateTagAssetResponse](#updatetagassetresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [UpdateTagAssetResponse](#updatetagassetresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/tags/templates
#### GET
+
##### Summary
Get all tag templates
@@ -1421,20 +1473,21 @@ Get all available tag templates
| Name | Located in | Description | Required | Schema |
| ---- | ---------- | ----------- | -------- | ------ |
-| urn | query | | No | string |
+| urn | query | | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllTagTemplatesResponse](#getalltagtemplatesresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | --------------------------------------------------------- |
+| 200 | A successful response. | [GetAllTagTemplatesResponse](#getalltagtemplatesresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### POST
+
##### Summary
Create a template
@@ -1445,24 +1498,25 @@ Create a new tag template
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| body | body | Request to be sent to create a tag's template | Yes | [CreateTagTemplateRequest](#createtagtemplaterequest) |
+| Name | Located in | Description | Required | Schema |
+| ---- | ---------- | --------------------------------------------- | -------- | ----------------------------------------------------- |
+| body | body | Request to be sent to create a tag's template | Yes | [CreateTagTemplateRequest](#createtagtemplaterequest) |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [CreateTagTemplateResponse](#createtagtemplateresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [CreateTagTemplateResponse](#createtagtemplateresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### /v1beta1/tags/templates/{template_urn}
#### GET
+
##### Summary
Get a tag template
@@ -1473,22 +1527,23 @@ Get a single tag template
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| template_urn | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------ |
+| template_urn | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetTagTemplateResponse](#gettagtemplateresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------- |
+| 200 | A successful response. | [GetTagTemplateResponse](#gettagtemplateresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### DELETE
+
##### Summary
Delete a tag template
@@ -1499,22 +1554,23 @@ Delete a single tag template
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| template_urn | path | | Yes | string |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------ |
+| template_urn | path | | Yes | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [DeleteTagTemplateResponse](#deletetagtemplateresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [DeleteTagTemplateResponse](#deletetagtemplateresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
#### PUT
+
##### Summary
Update a template
@@ -1525,27 +1581,28 @@ Update an existing tag template
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| template_urn | path | | Yes | string |
-| body | body | | Yes | { **"description"**: string, **"display_name"**: string, **"fields"**: [ [TagTemplateField](#tagtemplatefield) ] } |
+| Name | Located in | Description | Required | Schema |
+| ------------ | ---------- | ----------- | -------- | ------------------------------------------------------------------------------------------------------------------ |
+| template_urn | path | | Yes | string |
+| body | body | | Yes | { **"description"**: string, **"display_name"**: string, **"fields"**: [ [TagTemplateField](#tagtemplatefield) ] } |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [UpdateTagTemplateResponse](#updatetagtemplateresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------------------- |
+| 200 | A successful response. | [UpdateTagTemplateResponse](#updatetagtemplateresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
## default
### /v1beta1/types
#### GET
+
##### Summary
fetch all types
@@ -1556,578 +1613,578 @@ Fetch all types supported in Compass
##### Parameters
-| Name | Located in | Description | Required | Schema |
-| ---- | ---------- | ----------- | -------- | ------ |
-| q | query | filter by specific query | No | string |
-| q_fields | query | filter by multiple query fields | No | string |
-| types | query | filter by multiple types | No | string |
-| services | query | filter by multiple services | No | string |
+| Name | Located in | Description | Required | Schema |
+| -------- | ---------- | ------------------------------- | -------- | ------ |
+| q | query | filter by specific query | No | string |
+| q_fields | query | filter by multiple query fields | No | string |
+| types | query | filter by multiple types | No | string |
+| services | query | filter by multiple services | No | string |
##### Responses
-| Code | Description | Schema |
-| ---- | ----------- | ------ |
-| 200 | A successful response. | [GetAllTypesResponse](#getalltypesresponse) |
-| 400 | Returned when the data that user input is wrong. | [Status](#status) |
-| 404 | Returned when the resource does not exist. | [Status](#status) |
-| 409 | Returned when the resource already exist. | [Status](#status) |
-| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
-| default | An unexpected error response. | [Status](#status) |
+| Code | Description | Schema |
+| ------- | ----------------------------------------------------------- | ------------------------------------------- |
+| 200 | A successful response. | [GetAllTypesResponse](#getalltypesresponse) |
+| 400 | Returned when the data that user input is wrong. | [Status](#status) |
+| 404 | Returned when the resource does not exist. | [Status](#status) |
+| 409 | Returned when the resource already exist. | [Status](#status) |
+| 500 | Returned when theres is something wrong on the server side. | [Status](#status) |
+| default | An unexpected error response. | [Status](#status) |
### Models
#### Any
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| @type | string | | No |
+| Name | Type | Description | Required |
+| ----- | ------ | ----------- | -------- |
+| @type | string | | No |
#### Change
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| from | | | No |
-| path | [ string ] | | No |
-| to | | | No |
-| type | string | | No |
+| Name | Type | Description | Required |
+| ---- | ---------- | ----------- | -------- |
+| from | | | No |
+| path | [ string ] | | No |
+| to | | | No |
+| type | string | | No |
#### Comment
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| body | string | | No |
-| created_at | dateTime | | No |
-| discussion_id | string | | No |
-| id | string | | No |
-| owner | [User](#user) | | No |
-| updated_at | dateTime | | No |
-| updated_by | [User](#user) | | No |
+| Name | Type | Description | Required |
+| ------------- | ------------- | ----------- | -------- |
+| body | string | | No |
+| created_at | dateTime | | No |
+| discussion_id | string | | No |
+| id | string | | No |
+| owner | [User](#user) | | No |
+| updated_at | dateTime | | No |
+| updated_by | [User](#user) | | No |
#### CreateAssetProbeRequest.Probe
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| metadata | object | | No |
-| status | string | | Yes |
-| status_reason | string | | No |
-| timestamp | dateTime | | No |
+| Name | Type | Description | Required |
+| ------------- | -------- | ----------- | -------- |
+| metadata | object | | No |
+| status | string | | Yes |
+| status_reason | string | | No |
+| timestamp | dateTime | | No |
#### CreateAssetProbeResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### CreateCommentResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### CreateDiscussionRequest
Request to be sent to create a discussion
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| assets | [ string ] | | No |
-| assignees | [ string ] | | No |
-| body | string | | Yes |
-| labels | [ string ] | | No |
-| state | string | | No |
-| title | string | | Yes |
-| type | string | | No |
+| Name | Type | Description | Required |
+| --------- | ---------- | ----------- | -------- |
+| assets | [ string ] | | No |
+| assignees | [ string ] | | No |
+| body | string | | Yes |
+| labels | [ string ] | | No |
+| state | string | | No |
+| title | string | | Yes |
+| type | string | | No |
#### CreateDiscussionResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### CreateNamespaceRequest
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | optional, if not specified will be auto generated | No |
-| metadata | object | key value pairs as metadata for the namespace | No |
-| name | string | | No |
-| state | string | | No |
+| Name | Type | Description | Required |
+| -------- | ------ | ------------------------------------------------- | -------- |
+| id | string | optional, if not specified will be auto generated | No |
+| metadata | object | key value pairs as metadata for the namespace | No |
+| name | string | | No |
+| state | string | | No |
#### CreateNamespaceResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### CreateTagAssetRequest
Request to be sent to create a tag
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| asset_id | string | | Yes |
-| tag_values | [ [TagValue](#tagvalue) ] | | Yes |
-| template_description | string | | No |
-| template_display_name | string | | No |
-| template_urn | string | | Yes |
+| Name | Type | Description | Required |
+| --------------------- | ------------------------- | ----------- | -------- |
+| asset_id | string | | Yes |
+| tag_values | [ [TagValue](#tagvalue) ] | | Yes |
+| template_description | string | | No |
+| template_display_name | string | | No |
+| template_urn | string | | Yes |
#### CreateTagAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Tag](#v1beta1tag) | | No |
+| Name | Type | Description | Required |
+| ---- | -------------------------- | ----------- | -------- |
+| data | [v1beta1.Tag](#v1beta1tag) | | No |
#### CreateTagTemplateRequest
Request to be sent to create a tag's template
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| description | string | | Yes |
-| display_name | string | | Yes |
-| fields | [ [TagTemplateField](#tagtemplatefield) ] | | No |
-| urn | string | | Yes |
+| Name | Type | Description | Required |
+| ------------ | ----------------------------------------- | ----------- | -------- |
+| description | string | | Yes |
+| display_name | string | | Yes |
+| fields | [ [TagTemplateField](#tagtemplatefield) ] | | No |
+| urn | string | | Yes |
#### CreateTagTemplateResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [TagTemplate](#tagtemplate) | | No |
+| Name | Type | Description | Required |
+| ---- | --------------------------- | ----------- | -------- |
+| data | [TagTemplate](#tagtemplate) | | No |
#### DeleteAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| DeleteAssetResponse | object | | |
+| Name | Type | Description | Required |
+| ------------------- | ------ | ----------- | -------- |
+| DeleteAssetResponse | object | | |
#### DeleteCommentResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| DeleteCommentResponse | object | | |
+| Name | Type | Description | Required |
+| --------------------- | ------ | ----------- | -------- |
+| DeleteCommentResponse | object | | |
#### DeleteTagAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| DeleteTagAssetResponse | object | | |
+| Name | Type | Description | Required |
+| ---------------------- | ------ | ----------- | -------- |
+| DeleteTagAssetResponse | object | | |
#### DeleteTagTemplateResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| DeleteTagTemplateResponse | object | | |
+| Name | Type | Description | Required |
+| ------------------------- | ------ | ----------- | -------- |
+| DeleteTagTemplateResponse | object | | |
#### Discussion
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| assets | [ string ] | | No |
-| assignees | [ string ] | | No |
-| body | string | | No |
-| created_at | dateTime | | No |
-| id | string | | No |
-| labels | [ string ] | | No |
-| owner | [User](#user) | | No |
-| state | string | | No |
-| title | string | | No |
-| type | string | | No |
-| updated_at | dateTime | | No |
+| Name | Type | Description | Required |
+| ---------- | ------------- | ----------- | -------- |
+| assets | [ string ] | | No |
+| assignees | [ string ] | | No |
+| body | string | | No |
+| created_at | dateTime | | No |
+| id | string | | No |
+| labels | [ string ] | | No |
+| owner | [User](#user) | | No |
+| state | string | | No |
+| title | string | | No |
+| type | string | | No |
+| updated_at | dateTime | | No |
#### GetAllAssetsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
-| total | long | | No |
+| Name | Type | Description | Required |
+| ----- | ---------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
+| total | long | | No |
#### GetAllCommentsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [Comment](#comment) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ----------------------- | ----------- | -------- |
+| data | [ [Comment](#comment) ] | | No |
#### GetAllDiscussionsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [Discussion](#discussion) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ----------------------------- | ----------- | -------- |
+| data | [ [Discussion](#discussion) ] | | No |
#### GetAllTagTemplatesResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [TagTemplate](#tagtemplate) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------------- | ----------- | -------- |
+| data | [ [TagTemplate](#tagtemplate) ] | | No |
#### GetAllTagsByAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Tag](#v1beta1tag) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------------ | ----------- | -------- |
+| data | [ [v1beta1.Tag](#v1beta1tag) ] | | No |
#### GetAllTypesResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Type](#v1beta1type) ] | | No |
+| Name | Type | Description | Required |
+| ---- | -------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Type](#v1beta1type) ] | | No |
#### GetAssetByIDResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Asset](#v1beta1asset) | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------------ | ----------- | -------- |
+| data | [v1beta1.Asset](#v1beta1asset) | | No |
#### GetAssetByVersionResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Asset](#v1beta1asset) | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------------ | ----------- | -------- |
+| data | [v1beta1.Asset](#v1beta1asset) | | No |
#### GetAssetStargazersResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [User](#user) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ----------------- | ----------- | -------- |
+| data | [ [User](#user) ] | | No |
#### GetAssetVersionHistoryResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ---------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
#### GetCommentResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [Comment](#comment) | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------- | ----------- | -------- |
+| data | [Comment](#comment) | | No |
#### GetDiscussionResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [Discussion](#discussion) | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------- | ----------- | -------- |
+| data | [Discussion](#discussion) | | No |
#### GetGraphResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [LineageEdge](#lineageedge) ] | Edges in the graph. | No |
-| node_attrs | object | Key is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge. | No |
+| Name | Type | Description | Required |
+| ---------- | ------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -------- |
+| data | [ [LineageEdge](#lineageedge) ] | Edges in the graph. | No |
+| node_attrs | object | Key is the asset URN. Node attributes, if present, will be returned for source and target nodes in the LineageEdge. | No |
#### GetMyDiscussionsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [Discussion](#discussion) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ----------------------------- | ----------- | -------- |
+| data | [ [Discussion](#discussion) ] | | No |
#### GetMyStarredAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Asset](#v1beta1asset) | | No |
+| Name | Type | Description | Required |
+| ---- | ------------------------------ | ----------- | -------- |
+| data | [v1beta1.Asset](#v1beta1asset) | | No |
#### GetMyStarredAssetsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ---------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
#### GetNamespaceResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| namespace | [Namespace](#namespace) | | No |
+| Name | Type | Description | Required |
+| --------- | ----------------------- | ----------- | -------- |
+| namespace | [Namespace](#namespace) | | No |
#### GetTagByAssetAndTemplateResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Tag](#v1beta1tag) | | No |
+| Name | Type | Description | Required |
+| ---- | -------------------------- | ----------- | -------- |
+| data | [v1beta1.Tag](#v1beta1tag) | | No |
#### GetTagTemplateResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [TagTemplate](#tagtemplate) | | No |
+| Name | Type | Description | Required |
+| ---- | --------------------------- | ----------- | -------- |
+| data | [TagTemplate](#tagtemplate) | | No |
#### GetUserStarredAssetsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ---------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
#### LineageEdge
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| prop | object | | No |
-| source | string | | No |
-| target | string | | No |
+| Name | Type | Description | Required |
+| ------ | ------ | ----------- | -------- |
+| prop | object | | No |
+| source | string | | No |
+| target | string | | No |
#### LineageNode
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| service | string | | No |
-| type | string | | No |
-| urn | string | | No |
+| Name | Type | Description | Required |
+| ------- | ------ | ----------- | -------- |
+| service | string | | No |
+| type | string | | No |
+| urn | string | | No |
#### ListNamespacesResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| namespaces | [ [Namespace](#namespace) ] | | No |
+| Name | Type | Description | Required |
+| ---------- | --------------------------- | ----------- | -------- |
+| namespaces | [ [Namespace](#namespace) ] | | No |
#### Namespace
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
-| metadata | object | key value pairs as metadata for the namespace | No |
-| name | string | | No |
-| state | string | | No |
+| Name | Type | Description | Required |
+| -------- | ------ | --------------------------------------------- | -------- |
+| id | string | | No |
+| metadata | object | key value pairs as metadata for the namespace | No |
+| name | string | | No |
+| state | string | | No |
#### NodeAttributes
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| probes | [ProbesInfo](#probesinfo) | | No |
+| Name | Type | Description | Required |
+| ------ | ------------------------- | ----------- | -------- |
+| probes | [ProbesInfo](#probesinfo) | | No |
#### NullValue
`NullValue` is a singleton enumeration to represent the null value for the
`Value` type union.
- The JSON representation for `NullValue` is JSON `null`.
+The JSON representation for `NullValue` is JSON `null`.
- NULL_VALUE: Null value.
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| NullValue | string | `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. | |
+| Name | Type | Description | Required |
+| --------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| NullValue | string | `NullValue` is a singleton enumeration to represent the null value for the `Value` type union. The JSON representation for `NullValue` is JSON `null`. - NULL_VALUE: Null value. | |
#### PatchDiscussionResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| PatchDiscussionResponse | object | | |
+| Name | Type | Description | Required |
+| ----------------------- | ------ | ----------- | -------- |
+| PatchDiscussionResponse | object | | |
#### ProbesInfo
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| latest | [v1beta1.Probe](#v1beta1probe) | | No |
+| Name | Type | Description | Required |
+| ------ | ------------------------------ | ----------- | -------- |
+| latest | [v1beta1.Probe](#v1beta1probe) | | No |
#### SearchAssetsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
+| Name | Type | Description | Required |
+| ---- | ---------------------------------- | ----------- | -------- |
+| data | [ [v1beta1.Asset](#v1beta1asset) ] | | No |
#### StarAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### Status
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| code | integer | | No |
-| details | [ [Any](#any) ] | | No |
-| message | string | | No |
+| Name | Type | Description | Required |
+| ------- | --------------- | ----------- | -------- |
+| code | integer | | No |
+| details | [ [Any](#any) ] | | No |
+| message | string | | No |
#### SuggestAssetsResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [ string ] | | No |
+| Name | Type | Description | Required |
+| ---- | ---------- | ----------- | -------- |
+| data | [ string ] | | No |
#### TagTemplate
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| created_at | dateTime | | No |
-| description | string | | No |
-| display_name | string | | No |
-| fields | [ [TagTemplateField](#tagtemplatefield) ] | | No |
-| updated_at | dateTime | | No |
-| urn | string | | No |
+| Name | Type | Description | Required |
+| ------------ | ----------------------------------------- | ----------- | -------- |
+| created_at | dateTime | | No |
+| description | string | | No |
+| display_name | string | | No |
+| fields | [ [TagTemplateField](#tagtemplatefield) ] | | No |
+| updated_at | dateTime | | No |
+| urn | string | | No |
#### TagTemplateField
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| created_at | dateTime | | No |
-| data_type | string | | No |
-| description | string | | No |
-| display_name | string | | No |
-| id | long | | No |
-| options | [ string ] | | No |
-| required | boolean | | No |
-| updated_at | dateTime | | No |
-| urn | string | | No |
+| Name | Type | Description | Required |
+| ------------ | ---------- | ----------- | -------- |
+| created_at | dateTime | | No |
+| data_type | string | | No |
+| description | string | | No |
+| display_name | string | | No |
+| id | long | | No |
+| options | [ string ] | | No |
+| required | boolean | | No |
+| updated_at | dateTime | | No |
+| urn | string | | No |
#### TagValue
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| created_at | dateTime | | No |
-| field_data_type | string | | No |
-| field_description | string | | No |
-| field_display_name | string | | No |
-| field_id | long | | No |
-| field_options | [ string ] | | No |
-| field_required | boolean | | No |
-| field_urn | string | | No |
-| field_value | | | No |
-| updated_at | dateTime | | No |
+| Name | Type | Description | Required |
+| ------------------ | ---------- | ----------- | -------- |
+| created_at | dateTime | | No |
+| field_data_type | string | | No |
+| field_description | string | | No |
+| field_display_name | string | | No |
+| field_id | long | | No |
+| field_options | [ string ] | | No |
+| field_required | boolean | | No |
+| field_urn | string | | No |
+| field_value | | | No |
+| updated_at | dateTime | | No |
#### UnstarAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| UnstarAssetResponse | object | | |
+| Name | Type | Description | Required |
+| ------------------- | ------ | ----------- | -------- |
+| UnstarAssetResponse | object | | |
#### UpdateCommentResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| UpdateCommentResponse | object | | |
+| Name | Type | Description | Required |
+| --------------------- | ------ | ----------- | -------- |
+| UpdateCommentResponse | object | | |
#### UpdateNamespaceResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| UpdateNamespaceResponse | object | | |
+| Name | Type | Description | Required |
+| ----------------------- | ------ | ----------- | -------- |
+| UpdateNamespaceResponse | object | | |
#### UpdateTagAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [v1beta1.Tag](#v1beta1tag) | | No |
+| Name | Type | Description | Required |
+| ---- | -------------------------- | ----------- | -------- |
+| data | [v1beta1.Tag](#v1beta1tag) | | No |
#### UpdateTagTemplateResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | [TagTemplate](#tagtemplate) | | No |
+| Name | Type | Description | Required |
+| ---- | --------------------------- | ----------- | -------- |
+| data | [TagTemplate](#tagtemplate) | | No |
#### UpsertAssetRequest
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| asset | [UpsertAssetRequest.Asset](#upsertassetrequestasset) | | No |
-| downstreams | [ [LineageNode](#lineagenode) ] | | No |
-| upstreams | [ [LineageNode](#lineagenode) ] | | No |
+| Name | Type | Description | Required |
+| ----------- | ---------------------------------------------------- | ----------- | -------- |
+| asset | [UpsertAssetRequest.Asset](#upsertassetrequestasset) | | No |
+| downstreams | [ [LineageNode](#lineagenode) ] | | No |
+| upstreams | [ [LineageNode](#lineagenode) ] | | No |
#### UpsertAssetRequest.Asset
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | object | dynamic data of an asset | No |
-| description | string | | No |
-| labels | object | labels of an asset | No |
-| name | string | | No |
-| owners | [ [User](#user) ] | list of owners of the asset | No |
-| service | string | | No |
-| type | string | | No |
-| url | string | | No |
-| urn | string | | No |
+| Name | Type | Description | Required |
+| ----------- | ----------------- | --------------------------- | -------- |
+| data | object | dynamic data of an asset | No |
+| description | string | | No |
+| labels | object | labels of an asset | No |
+| name | string | | No |
+| owners | [ [User](#user) ] | list of owners of the asset | No |
+| service | string | | No |
+| type | string | | No |
+| url | string | | No |
+| urn | string | | No |
#### UpsertAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### UpsertPatchAssetRequest
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| asset | [UpsertPatchAssetRequest.Asset](#upsertpatchassetrequestasset) | | No |
-| downstreams | [ [LineageNode](#lineagenode) ] | | No |
-| overwrite_lineage | boolean | overwrite_lineage determines whether the asset's lineage should be overwritten with the upstreams and downstreams specified in the request. Currently, it is only applicable when both upstreams and downstreams are empty/not specified. | No |
-| upstreams | [ [LineageNode](#lineagenode) ] | | No |
+| Name | Type | Description | Required |
+| ----------------- | -------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------- |
+| asset | [UpsertPatchAssetRequest.Asset](#upsertpatchassetrequestasset) | | No |
+| downstreams | [ [LineageNode](#lineagenode) ] | | No |
+| overwrite_lineage | boolean | overwrite_lineage determines whether the asset's lineage should be overwritten with the upstreams and downstreams specified in the request. Currently, it is only applicable when both upstreams and downstreams are empty/not specified. | No |
+| upstreams | [ [LineageNode](#lineagenode) ] | | No |
#### UpsertPatchAssetRequest.Asset
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| data | object | dynamic data of an asset | No |
-| description | string | description of an asset | No |
-| labels | object | labels of an asset | No |
-| name | string | name of an asset | No |
-| owners | [ [User](#user) ] | list of owners of the asset | No |
-| service | string | | No |
-| type | string | | No |
-| url | string | | No |
-| urn | string | | No |
+| Name | Type | Description | Required |
+| ----------- | ----------------- | --------------------------- | -------- |
+| data | object | dynamic data of an asset | No |
+| description | string | description of an asset | No |
+| labels | object | labels of an asset | No |
+| name | string | name of an asset | No |
+| owners | [ [User](#user) ] | list of owners of the asset | No |
+| service | string | | No |
+| type | string | | No |
+| url | string | | No |
+| urn | string | | No |
#### UpsertPatchAssetResponse
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| id | string | | No |
+| Name | Type | Description | Required |
+| ---- | ------ | ----------- | -------- |
+| id | string | | No |
#### User
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| created_at | dateTime | | No |
-| email | string | | No |
-| id | string | | No |
-| provider | string | | No |
-| updated_at | dateTime | | No |
-| uuid | string | | No |
+| Name | Type | Description | Required |
+| ---------- | -------- | ----------- | -------- |
+| created_at | dateTime | | No |
+| email | string | | No |
+| id | string | | No |
+| provider | string | | No |
+| updated_at | dateTime | | No |
+| uuid | string | | No |
#### v1beta1.Asset
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| changelog | [ [Change](#change) ] | | No |
-| created_at | dateTime | | No |
-| data | object | | No |
-| description | string | | No |
-| id | string | | No |
-| labels | object | | No |
-| name | string | | No |
-| owners | [ [User](#user) ] | | No |
-| probes | [ [v1beta1.Probe](#v1beta1probe) ] | | No |
-| service | string | | No |
-| type | string | | No |
-| updated_at | dateTime | | No |
-| updated_by | [User](#user) | | No |
-| url | string | | No |
-| urn | string | | No |
-| version | string | | No |
+| Name | Type | Description | Required |
+| ----------- | ---------------------------------- | ----------- | -------- |
+| changelog | [ [Change](#change) ] | | No |
+| created_at | dateTime | | No |
+| data | object | | No |
+| description | string | | No |
+| id | string | | No |
+| labels | object | | No |
+| name | string | | No |
+| owners | [ [User](#user) ] | | No |
+| probes | [ [v1beta1.Probe](#v1beta1probe) ] | | No |
+| service | string | | No |
+| type | string | | No |
+| updated_at | dateTime | | No |
+| updated_by | [User](#user) | | No |
+| url | string | | No |
+| urn | string | | No |
+| version | string | | No |
#### v1beta1.Probe
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| asset_urn | string | | No |
-| created_at | dateTime | | No |
-| id | string | | No |
-| metadata | object | | No |
-| status | string | | No |
-| status_reason | string | | No |
-| timestamp | dateTime | | No |
+| Name | Type | Description | Required |
+| ------------- | -------- | ----------- | -------- |
+| asset_urn | string | | No |
+| created_at | dateTime | | No |
+| id | string | | No |
+| metadata | object | | No |
+| status | string | | No |
+| status_reason | string | | No |
+| timestamp | dateTime | | No |
#### v1beta1.Tag
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| asset_id | string | | No |
-| tag_values | [ [TagValue](#tagvalue) ] | | No |
-| template_description | string | | No |
-| template_display_name | string | | No |
-| template_urn | string | | No |
+| Name | Type | Description | Required |
+| --------------------- | ------------------------- | ----------- | -------- |
+| asset_id | string | | No |
+| tag_values | [ [TagValue](#tagvalue) ] | | No |
+| template_description | string | | No |
+| template_display_name | string | | No |
+| template_urn | string | | No |
#### v1beta1.Type
-| Name | Type | Description | Required |
-| ---- | ---- | ----------- | -------- |
-| count | long | | No |
-| name | string | | No |
+| Name | Type | Description | Required |
+| ----- | ------ | ----------- | -------- |
+| count | long | | No |
+| name | string | | No |
diff --git a/docs/docs/roadmap.md b/docs/docs/roadmap.md
index 03a0c472..23ae5a1a 100644
--- a/docs/docs/roadmap.md
+++ b/docs/docs/roadmap.md
@@ -1,11 +1,11 @@
# Roadmap
-In the following section you can learn about what features we're working on, what stage they're in, and when we expect to bring them to you. Have any questions or comments about items on the roadmap? Join the [discussions](https://github.com/odpf/compass/core/discussions) on Compass Github forum.
+In the following section you can learn about what features we're working on, what stage they're in, and when we expect to bring them to you. Have any questions or comments about items on the roadmap? Join the [discussions](https://github.com/raystack/compass/core/discussions) on Compass Github forum.
If you would like to suggest new items or request timeline changes to the existing items, please submit a GitHub feature request.
-We’re planning to iterate on the format of the roadmap itself, and we see potential to engage more in discussions about the future of Compass features. If you have feedback about this roadmap section itself, such as how the issues are presented, let us know through [discussions](https://github.com/odpf/compass/core/discussions).
+We’re planning to iterate on the format of the roadmap itself, and we see potential to engage more in discussions about the future of Compass features. If you have feedback about this roadmap section itself, such as how the issues are presented, let us know through [discussions](https://github.com/raystack/compass/core/discussions).
### Compass 0.2.x
-* User Activity and Notification
+- User Activity and Notification
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
index 56729e89..98a7ca2d 100644
--- a/docs/docusaurus.config.js
+++ b/docs/docusaurus.config.js
@@ -6,12 +6,12 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
(module.exports = {
title: 'Compass',
tagline: 'Data Catalog',
- url: 'https://odpf.github.io/',
+ url: 'https://raystack.github.io/',
baseUrl: '/compass/',
onBrokenLinks: 'throw',
onBrokenMarkdownLinks: 'warn',
favicon: 'assets/favicon.ico',
- organizationName: 'ODPF',
+ organizationName: 'Raystack',
projectName: 'compass',
presets: [
@@ -24,7 +24,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
docs: {
routeBasePath: '/',
sidebarPath: require.resolve('./sidebars.js'),
- editUrl: 'https://github.com/odpf/compass/edit/master/docs/',
+ editUrl: 'https://github.com/raystack/compass/edit/master/docs/',
sidebarCollapsed: true,
},
blog: false,
@@ -63,7 +63,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
className: 'header-slack-link',
},
{
- href: 'https://github.com/odpf/compass',
+ href: 'https://github.com/raystack/compass',
className: 'navbar-item-github',
position: 'right',
},
@@ -75,10 +75,10 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
{
title: 'Products',
items: [
- { label: 'Optimus', href: 'https://github.com/odpf/optimus' },
- { label: 'Firehose', href: 'https://github.com/odpf/firehose' },
- { label: 'Raccoon', href: 'https://github.com/odpf/raccoon' },
- { label: 'Dagger', href: 'https://odpf.github.io/dagger/' },
+ { label: 'Optimus', href: 'https://github.com/raystack/optimus' },
+ { label: 'Firehose', href: 'https://github.com/raystack/firehose' },
+ { label: 'Raccoon', href: 'https://github.com/raystack/raccoon' },
+ { label: 'Dagger', href: 'https://raystack.github.io/dagger/' },
],
},
{
@@ -92,7 +92,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
title: 'Community',
items: [
{ label: 'Slack', href: 'https://bit.ly/2RzPbtn' },
- { label: 'GitHub', href: 'https://github.com/odpf/compass' }
+ { label: 'GitHub', href: 'https://github.com/raystack/compass' }
],
},
],
@@ -103,7 +103,7 @@ const darkCodeTheme = require('prism-react-renderer/themes/dracula');
},
announcementBar: {
id: 'star-repo',
- content: '⭐️ If you like Compass, give it a star on GitHub! ⭐',
+ content: '⭐️ If you like Compass, give it a star on GitHub! ⭐',
backgroundColor: '#222',
textColor: '#eee',
isCloseable: true,
diff --git a/docs/src/pages/help.js b/docs/src/pages/help.js
index 8ddb6ca1..fb85cf69 100644
--- a/docs/src/pages/help.js
+++ b/docs/src/pages/help.js
@@ -25,7 +25,7 @@ export default function Home() {
The Compass team has an open source slack workspace to discuss development and support.
Most of the Compass discussions happen in #compass channel.
- Join us on Slack
+ Join us on Slack
Have a general issue or bug that you've found? We'd love to hear about it in our GitHub issues. This can be feature requests too!
- Go to issues
+ Go to issues