Changes

Page history
Update Core Services API Docs authored by Chad Leong's avatar Chad Leong
Show whitespace changes
Inline Side-by-side
Core-Services-API-Docs.md
View page @ 9256443c
# Core Services API Docs
## Core Services
[Core Services Overview](https://community.opengroup.org/osdu/documentation/-/wikis/Core%20Services%20Overview)
| Services | Community Implementation | Azure | AWS [Protected] | GC |
|---------- | ------ | ----- | ------ |------ |
| Storage | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/storage/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/storage/v2/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/storage/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/storage/v2/swagger-ui/index.html) |
| File | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/file/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/file/v2/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/file/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/file/v2/swagger-ui/index.html) |
| Dataset | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) |
| Indexer | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/indexer/v2/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/indexer/v2/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/indexer/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/indexer/v2/swagger-ui/index.html) |
| Notification | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/notification/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/notification/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/notification/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/notification/v1/swagger-ui/index.html) |
| Schema | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/schema-service/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/schema-service/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/schema-service/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/schema-service/v1/swagger-ui/index.html) |
| Search | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/search/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/search/v2/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/search/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/search/v2/swagger-ui/index.html) |
| Entitlements | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/entitlements/v2/swagger-ui/index.html) |
| Partition | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/partition/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/partition/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/partition/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/partition/v1/swagger-ui/index.html) |
| Legal | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/legal/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/legal/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/legal/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/legal/v1/swagger-ui/index.html) |
| Register | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/register/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/register/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/register/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/register/v1/swagger-ui/index.html) |
| Policy | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/policy/v1/docs) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/policy/v1/docs) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/policy/v1/docs) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/policy/v1/docs) |
| Secret | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/secret/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/secret/v1/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/secret/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/secret/v1/swagger-ui/index.html) |
# Reference and Helper Services API Docs
| Storage | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/storage/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/storage/v2/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/storage/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/storage/v2/swagger-ui/index.html) |
| File | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/file/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/file/v2/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/file/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/file/v2/swagger-ui/index.html) |
| Dataset | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/dataset/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) |
| Indexer | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/indexer/v2/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/indexer/v2/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/indexer/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/indexer/v2/swagger-ui/index.html) |
| Notification | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/notification/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/notification/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/notification/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/notification/v1/swagger-ui/index.html) |
| Schema | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/schema-service/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/schema-service/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/schema-service/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/schema-service/v1/swagger-ui/index.html) |
| Search | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/search/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/search/v2/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/search/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/search/v2/swagger-ui/index.html) |
| Entitlements | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/entitlements/v2/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/entitlements/v2/swagger-ui/index.html) |
| Partition | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/partition/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/partition/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/partition/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/partition/v1/swagger-ui/index.html) |
| Legal | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/legal/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/legal/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/legal/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/legal/v1/swagger-ui/index.html) |
| Register | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/register/v1/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/register/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/register/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/register/v1/swagger-ui/index.html) |
| Policy | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/policy/v1/docs) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/policy/v1/docs) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/policy/v1/docs) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/policy/v1/docs) |
| Secret | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/secret/v1/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/secret/v1/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/secret/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/secret/v1/swagger-ui/index.html) |
## Reference and Helper Services
| Services | Community Implementation | Azure | AWS [Protected] | GC |
|---------- | ------ | ----- | ------ |------ |
| CRS Conversion | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/crs/converter/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/crs/converter/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/crs/converter/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/crs/converter/swagger-ui/index.html) |
| CRS Catalog | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/crs/catalog/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/crs/catalog/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/crs/catalog/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/crs/catalog/swagger-ui/index.html) |
| Unit | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/unit/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/unit/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/unit/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/unit/swagger-ui/index.html) |
# Data Flow Services
| Services | Community Implementation | Azure | AWS [Protected] | GC |
|---------- | ------ | ----- | ------ |------ |
| CRS Conversion | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/crs/converter/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/crs/converter/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/crs/converter/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/crs/converter/swagger-ui/index.html) |
| CRS Catalog | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/crs/catalog/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/crs/catalog/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/crs/catalog/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/crs/catalog/swagger-ui/index.html) |
| Unit | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/unit/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/unit/swagger-ui/index.html) | [API Doc](https://r3m17ps.preshiptesting.osdu.aws/api/unit/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/unit/swagger-ui/index.html) |
| Ingestion Workflow Service | [API Doc](https://osdu.bm-preship.gcp.gnrg-osdu.projects.epam.com/api/workflow/swagger-ui/index.html) |[API Doc](https://osdu-ship.msft-osdu-test.org/api/workflow/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/workflow/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/workflow/swagger-ui/index.html) |