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 @ 865de220
......@@ -8,34 +8,34 @@ These are code-generated swagger docs running from the OSDU pre-shipping instanc
| Services | Community Implementation | Azure | AWS \[Protected\] | GC |
|----------|--------------------------|-------|-------------------|----|
| Dataset | [API Doc](https://osdu.core-dev.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://osdu.bm22.gcp.gnrg-osdu.projects.epam.com/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) |
| Entitlements | [API Doc](https://osdu.core-dev.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) |
| File | [API Doc](https://osdu.core-dev.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) |
| Indexer | [API Doc](https://osdu.core-dev.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) |
| Legal | [API Doc](https://osdu.core-dev.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) |
| Notification | [API Doc](https://osdu.core-dev.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) |
| Partition | [API Doc](https://osdu.core-dev.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) |
| Policy | [API Doc](https://osdu.core-dev.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) |
| Register | [API Doc](https://osdu.core-dev.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) |
| Schema | [API Doc](https://osdu.core-dev.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.core-dev.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) |
| Secret | [API Doc](https://osdu.core-dev.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) |
| Storage | [API Doc](https://osdu.core-dev.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) |
| Dataset | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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://osdu.bm22.gcp.gnrg-osdu.projects.epam.com/v1/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/dataset/v1/swagger-ui/index.html) |
| Entitlements | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| File | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Indexer | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Legal | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Notification | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Partition | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Policy | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Register | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Schema | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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.dev1.osdu-cimpl.opengroup.org//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) |
| Secret | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
| Storage | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
## Reference and Helper Services
| Services | Community Implementation | Azure | AWS \[Protected\] | GC |
|----------|--------------------------|-------|-------------------|----|
| CRS Conversion | [API Doc](https://osdu.core-dev.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.core-dev.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.core-dev.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) |
| CRS Conversion | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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.dev1.osdu-cimpl.opengroup.org//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.dev1.osdu-cimpl.opengroup.org//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) |
| Schema Upgrade | | [API Doc](https://osdu-glab.msft-osdu-test.org/api/schemaupgrade/v2/swagger-ui/index.html#/) | | |
## Data Flow Services
| Services | Community Implementation | Azure | AWS \[Protected\] | GC |
|----------|--------------------------|-------|-------------------|----|
| Ingestion Workflow Service | [API Doc](https://osdu.core-dev.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) |
| Ingestion Workflow Service | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//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) |
## Domain Data Management Services
......@@ -43,9 +43,9 @@ These are code-generated swagger docs running from the OSDU pre-shipping instanc
|----------|--------------------------|-------|-------------------|----|
| Seismic DDMS v3 | | [API Doc](https://osdu-glab.msft-osdu-test.org/seistore-svc/api/v3/swagger-ui.html/) | | |
| Seismic DDMS v4 | | [API Doc](https://osdu-glab.msft-osdu-test.org/seistore-svc/api/v4/swagger-ui.html/) | | |
| Wellbore DDMS | [API Doc](https://osdu.core-dev.gcp.gnrg-osdu.projects.epam.com/api/os-wellbore-ddms/docs) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/os-wellbore-ddms/docs) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/os-wellbore-ddms/docs) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/os-wellbore-ddms/docs) |
| Wellbore DDMS | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//api/os-wellbore-ddms/docs) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/os-wellbore-ddms/docs) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/os-wellbore-ddms/docs) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/os-wellbore-ddms/docs) |
| RAFS DDMS | | [API Doc](https://osdu-ship.msft-osdu-test.org/api/rafs-ddms/docs) | | |
| Reservoir DDMS | | [API Doc](https://osdu-glab.msft-osdu-test.org/api/reservoir-ddms/v2/) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/reservoir-ddms/v2/) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/reservoir-ddms/v2/) |
| Well Delivery DDMS | [API Doc](https://osdu.core-dev.gcp.gnrg-osdu.projects.epam.com/api/well-delivery/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/well-delivery/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/well-delivery/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/well-delivery/swagger-ui/index.html) |
| Well Delivery DDMS | [API Doc](https://osdu.dev1.osdu-cimpl.opengroup.org//api/well-delivery/swagger-ui/index.html) | [API Doc](https://osdu-ship.msft-osdu-test.org/api/well-delivery/swagger-ui/index.html) | [API Doc](https://prsh.testing.preshiptesting.osdu.aws/api/well-delivery/swagger-ui/index.html) | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/well-delivery/swagger-ui/index.html) |
| Production DDMS - Historian | | - [API Doc - Entities Management](https://osdu-glab.msft-osdu-test.org/api/pddms/entities/service/timeseries/v1/swagger-ui/index.html) <br> - [API Doc - Property Discovery](https://osdu-glab.msft-osdu-test.org/api/pddms/ppsproperties/service/timeseries/v1/swagger-ui/index.html) <br> - [API Doc - Source Management](https://osdu-glab.msft-osdu-test.org/api/pddms/ppssource/api/source/v1/swagger-ui/index.html) <br> - [API Doc - Time-series](https://osdu-glab.msft-osdu-test.org/api/pddms/ppstimeseries/service/timeseries/v1/swagger-ui/index.html) <br> - [API Doc - Time-series Management](https://osdu-glab.msft-osdu-test.org/api/pddms/writeback/service/timeseries-management/v1/swagger-ui/index.html) | | |
| Production DDMS - Core | | | | [API Doc](https://preship.gcp.gnrg-osdu.projects.epam.com/api/dspdm/v1/apidocs/) |
\ No newline at end of file