Changes

Page history
Added link for REFI QSG authored by Dzmitry Malkevich (EPAM)'s avatar Dzmitry Malkevich (EPAM)
Hide whitespace changes
Inline Side-by-side
OSDU-API-Quick-start-guide.md
View page @ fe12efa6
- [Purpose of the document](#purpose-of-the-document) - [Purpose of the document](#purpose-of-the-document)
- [GC vs REFI deployment](#gc-vs-refi-deployment)
- [Configuring a Postman environment](#configuring-a-postman-environment) - [Configuring a Postman environment](#configuring-a-postman-environment)
- [Working with OSDU](#working-with-osdu) - [Working with OSDU](#working-with-osdu)
- [Schema creation](#schema-creation) - [Schema creation](#schema-creation)
...@@ -33,6 +34,10 @@ The document goals are: ...@@ -33,6 +34,10 @@ The document goals are:
This document is not intended to introduce you to all OSDU services. For full OSDU documentation please use [the link](https://osduforum.org/getting-started/osdu-documentation/) This document is not intended to introduce you to all OSDU services. For full OSDU documentation please use [the link](https://osduforum.org/getting-started/osdu-documentation/)
### GC vs REFI deployment
This guide is for GC deployment. If you are using reference implementation (REFI) please refer to [this guide](https://community.opengroup.org/osdu/documentation/-/wikis/OSDU-REFI-QSG) to configure Postman and manage users and their permissions. Then continue with [Working with OSDU](#working-with-osdu) section.
### Configuring a Postman environment ### Configuring a Postman environment
OSDU uses the Postman tool to do majority of API testing. Here are the pre-requisites and the steps you need to perform to configure Postman environment. OSDU uses the Postman tool to do majority of API testing. Here are the pre-requisites and the steps you need to perform to configure Postman environment.
...@@ -311,15 +316,21 @@ Part of the file: ...@@ -311,15 +316,21 @@ Part of the file:
![image021](uploads/3aabfc7977d5277b9cf0cee769b595c3/image021.png) ![image021](uploads/3aabfc7977d5277b9cf0cee769b595c3/image021.png)
<div>Image 11.An example of the image data</div>### Example: Data ingestion using Cloud Tools <div>Image 11.An example of the image data</div>
### Example: Data ingestion using Cloud Tools
Users can access OSDU Storage Service using cloud tools and just upload needed files there. Here is an example of how to do this on Google Cloud Platform (GCP). Users can access OSDU Storage Service using cloud tools and just upload needed files there. Here is an example of how to do this on Google Cloud (GC). This way is not supported in REFI implementation.
**Step 1. Load file(s)** The Storage Service has a specified bucket in the OSDU environment, and a user can directly upload a file into this bucket. **<span dir="">_TBD – how to get the name of the bucket (to delete?):_</span>** **Step 1. Load file(s)**
The Storage Service has a specified bucket in the OSDU environment, and a user can directly upload a file into this bucket. **<span dir="">_TBD – how to get the name of the bucket (to delete?):_</span>**
![image023](uploads/c96b9c2bb31aacf0d454d7272149024e/image023.png) ![image023](uploads/c96b9c2bb31aacf0d454d7272149024e/image023.png)
<div>Image 12. Loading files using Cloud Storage</div>#### Step 2. Obtain File DownloadURL <div>Image 12. Loading files using Cloud Storage</div>
**Step 2. Obtain File DownloadURL**
After loading a file into OSDU Storage Service bucket, user should obtain DownloadURL. It is a File Location in the Storage Service: After loading a file into OSDU Storage Service bucket, user should obtain DownloadURL. It is a File Location in the Storage Service:
... ...
......