Skip to content

Commit

Permalink
Use types from @/types/models
Browse files Browse the repository at this point in the history
  • Loading branch information
mikepsinn committed Apr 26, 2024
1 parent 8169b8b commit f834f4e
Show file tree
Hide file tree
Showing 4 changed files with 20 additions and 20 deletions.
4 changes: 2 additions & 2 deletions apps/api-gateway/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# FDAi API Gateway
# Decentralized FDA API Gateway

_Digital Twin Application Programming Interface (DT-API) Specification_

Expand Down Expand Up @@ -66,7 +66,7 @@ fetch('https://app.quantimo.do/api/v3/variables?limit=100', options)

### Authentication

To use the FDAi API, you first need to get an access token as described below. Once you have the token, include it in any of the [API requests documented here](https://curedao.org/api-docs) using the `Authorization` header in the format `Bearer YOUR_TOKEN_HERE`.
To use the Decentralized FDA API, you first need to get an access token as described below. Once you have the token, include it in any of the [API requests documented here](https://curedao.org/api-docs) using the `Authorization` header in the format `Bearer YOUR_TOKEN_HERE`.

#### Option 1: Use Demo Data
If you don't have your own data yet, you can use the access token `demo` in the `Authorization` header in the format `Bearer demo`.
Expand Down
16 changes: 8 additions & 8 deletions docs/api-docs/api-reference/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
---
title: 'Getting Started'
description: 'Introduction to the FDAi API and how to get started'
description: 'Introduction to the dFDA API and how to get started'
---

<Note>
Welcome to the FDAi API documentation! This guide will help you get started with using the FDAi API to build powerful applications and integrate data insights.
Welcome to the dFDA API documentation! This guide will help you get started with using the dFDA API to build powerful applications and integrate data insights.
</Note>

## API Overview

The FDAi API provides a comprehensive set of endpoints for tracking measurements, analyzing data, managing studies, and more. With the FDAi API, you can:
The dFDA API provides a comprehensive set of endpoints for tracking measurements, analyzing data, managing studies, and more. With the dFDA API, you can:

- Record and manage user measurements
- Retrieve user-specific analysis settings and statistics
Expand All @@ -18,7 +18,7 @@ The FDAi API provides a comprehensive set of endpoints for tracking measurements
- Perform advanced analytics and data correlations

<Card
title="FDAi API Specification"
title="dFDA API Specification"
icon="file-code"
href="/api-reference/openapi.yml"
>
Expand All @@ -40,15 +40,15 @@ Make sure to keep your client credentials secure and do not share them publicly.
icon="lock"
href="/guides/get-access-token"
>
Learn more about authenticating with the FDAi API
Learn more about authenticating with the dFDA API
</Card>

Getting Started
To start using the FDAi API, follow these steps:
To start using the dFDA API, follow these steps:

Sign up for an account at https://builder.dfda.earth to obtain your API credentials.
Explore the API endpoints and their functionalities in the API Reference section.
Check out the Guides section for tutorials and examples on how to use the FDAi API for various use cases.
Start building your application by making requests to the FDAi API endpoints using your client credentials.
Check out the Guides section for tutorials and examples on how to use the dFDA API for various use cases.
Start building your application by making requests to the dFDA API endpoints using your client credentials.

If you have any questions or need assistance, feel free to [create an issue](https://github.com/FDA-AI/FDAi/issues/new)
2 changes: 1 addition & 1 deletion docs/api-docs/guides/get-access-token.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting an Access Token
description: This is the first step to interact with the FDAi API. Learn how to create a user and get an access token.
description: This is the first step to interact with the dFDA API. Learn how to create a user and get an access token.
---

You can check the [API documentation](../api-reference/user/post-user) to generate code to do this in any language.
Expand Down
18 changes: 9 additions & 9 deletions docs/api-docs/introduction.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Introduction
description: 'Welcome to the FDAi API Documentation'
description: 'Welcome to the dFDA API Documentation'
---

<img
Expand All @@ -16,7 +16,7 @@ description: 'Welcome to the FDAi API Documentation'

## Getting Started

To start using the FDAi API, follow these steps:
To start using the dFDA API, follow these steps:

<CardGroup cols={2}>
<Card
Expand All @@ -35,44 +35,44 @@ To start using the FDAi API, follow these steps:
</Card>
</CardGroup>

## Build with FDAi
## Build with the API

Leverage the FDAi API to build powerful applications and integrate data insights.
Leverage the dFDA API to build powerful applications and integrate data insights.

<CardGroup cols={2}>
<Card
title="Create a User"
icon="user"
href="/guides/get-access-token"
>
The first step to interact with the FDAi API is to create an FDAi user linked to the user in your system
The first step to interact with the dFDA API is to create a user linked to the user in your system
</Card>
<Card
title="Create Measurements"
icon="chart-line"
href="/guides/record-measurements"
>
Learn how to record and manage measurements using the FDAi API
Learn how to record and manage measurements
</Card>
<Card
title="Get Measurements"
icon="chart-line"
href="/guides/get-measurements"
>
Learn how to record and manage measurements using the FDAi API
Learn how to retrieve measurements
</Card>
<Card
title="Create a Study"
icon="flask"
href="/guides/create-study"
>
Create studies using the FDAi API's study management features
Create studies using the dFDA study management features
</Card>
</CardGroup>

## Community and Support

Connect with the FDAi community and get the support you need.
Connect with the community and get the support you need.

<CardGroup cols={2}>
<Card
Expand Down

0 comments on commit f834f4e

Please sign in to comment.