Skip to content

Commit 81c129d

Browse files
ES 7 warning + components disclaimer
1 parent 54e6b6c commit 81c129d

File tree

9 files changed

+100
-75
lines changed

9 files changed

+100
-75
lines changed

website/docs/01-core-software/01-core-software.mdx

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,21 @@ import DocCardList from '@theme/DocCardList';
66

77
![Core Software](./images/core-software.webp 'Core Software')
88

9+
:::info
10+
Overture is a genomics data platform that combines front and back-end services. Stage handles navigation, while Arranger enables data search. Authentication runs through Keycloak/Ego, Song manages metadata, Score handles S3 file transfers, and Maestro indexes to Elasticsearch for Arranger's search functionality. Together, these components enable efficient genomics data management.
11+
:::
12+
13+
## Documentation Structure
14+
915
Our core software documentation is organized as follows:
1016

11-
```
12-
.
13-
└── /Service/
14-
├── /Overview
15-
├── /Setup
16-
└── /Usage
17-
```
17+
```
18+
.
19+
└── /Service/
20+
├── /Overview
21+
├── /Setup
22+
└── /Usage
23+
```
1824

1925
### Overview
2026

website/guides/01-deployment-guide/03-search-portal.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,15 @@ Setting up your data portal involves configuring and running Elasticsearch, Maes
3939

4040
</details>
4141

42+
43+
:::warning We use Elasticsearch 7
44+
45+
Our search platform is built on and compatible with version 7.x of Elasticsearch. Applications and queries need to follow Elasticsearch 7 syntax and conventions.
46+
47+
:::
48+
49+
Would you like me to explain any specific Elasticsearch 7 features or compatibility considerations in more detail?
50+
4251
2. **Supply an index template:** Create a folder titled `elasticsearchConfigs`
4352

4453
Download and place the following **[quickstart_index_template.json](https://raw.githubusercontent.com/overture-stack/composer/develop/configurationFiles/elasticsearchConfigs/quickstart_index_template.json)** within your `elasticsearchConfigs` folder. This file specifies settings, mappings, and configurations that will be applied automatically to new indices that match the template's pattern

website/guides/02-administration-guides/02-index-mappings.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,13 @@ Depending on how Maestro is configured it can index data into documents in one o
1414

1515
The index mapping can be defined within an index template supplied to Elasticsearch on startup. In the next section we will break down the structure of an index template.
1616

17+
:::warning We use Elasticsearch 7
18+
19+
Our search platform is built on and compatible with version 7.x of Elasticsearch. Applications and queries need to follow Elasticsearch 7 syntax and conventions.
20+
21+
:::
22+
23+
1724
# Breaking Down Index Templates
1825

1926
When broken down the index template has four components, `index_patterns`, `aliases`, `mappings`, and `settings`

website/guides/04-api-guides/01-rest-apis.mdx

Lines changed: 0 additions & 52 deletions
This file was deleted.

website/guides/04-api-guides/02-gql-api.md

Lines changed: 0 additions & 3 deletions
This file was deleted.

website/guides/04-api-guides/04-api-guides.mdx

Lines changed: 0 additions & 11 deletions
This file was deleted.
Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# API Reference
2+
3+
Welcome to our API reference documentation. This page provides detailed information about our available APIs.
4+
You can explore the endpoints, request parameters and response schemas directly from this page.
5+
6+
The Overture Platform has four APIs:
7+
8+
1. [**Song:**](/guides/api-guides/rest-apis#song-api) A RESTful (Swagger) API for file metadata stored in Song.
9+
2. [**Score:**](http://localhost:3000/guides/api-guides/rest-apis#score-api) RESTful (Swagger) API for communicating with the Score Server.
10+
3. [**Maestro:**](/guides/api-guides/rest-apis#maestro-api) RESTful (Swagger) API for managing Song data indexing operations.
11+
4. [**Arranger:**](/guides/api-guides/gql-api) GraphQL API for querying Indexed data within elasticsearch.
12+
13+
:::info Important Note
14+
Arranger API Reference documentation is currently under development and will be available soon. If you encounter any issues or have questions about our API, please don't hesitate to reach out through our relevant [**community support channels**](/community/support).
15+
:::
16+
17+
## RESTful APIs
18+
19+
import SwaggerAPIDoc from '/src/components/SwaggerAPIDoc';
20+
21+
All our available RESTful APIs use Swagger to help document endpoint usage and expected outcomes. Here are some tips for using the Swagger UI:
22+
23+
1. **Expand Operations**: Click on an endpoint to expand its details.
24+
2. **Read Descriptions**: Each endpoint has a description explaining its purpose and usage.
25+
3. **Check Parameters**: Review the required and optional parameters for each endpoint.
26+
4. **Examine Responses**: Look at the possible response codes and schemas to understand what to expect from each endpoint.
27+
28+
### Song API
29+
30+
The Song API allows you to manage and query file metadata in your system.
31+
32+
#### Key Features
33+
34+
- Manage study, analysis, donor, specimen, and sample metadata
35+
- Validate and submit analysis metadata with schema versioning and publication controls (published/unpublished/suppressed)
36+
- Manage schemas used for validations
37+
- Check the health of the Song-server
38+
39+
<SwaggerAPIDoc specName="song" />
40+
41+
### Score API
42+
43+
The Score API provides endpoints that allow to to query the Score server and programmatically transfer files to and from object storage.
44+
45+
#### Key Features
46+
47+
- Manage file uploads and downloads with multipart support and recovery mechanisms
48+
- Track and verify file integrity using MD5 checksums and progress monitoring
49+
- Control object storage with flexible listing, partial content handling, and secure access controls
50+
51+
<SwaggerAPIDoc specName="score" />
52+
53+
### Maestro API
54+
55+
The Maestro API provides you with endpoints for data indexing.
56+
57+
#### Key Features
58+
59+
- Index Song repositories by analysis or study ID
60+
- Convert analysis-centric data to file-centric document format
61+
- Manage index operations at repository, study, and analysis levels with failure tracking
62+
63+
<SwaggerAPIDoc specName="maestro" />
64+
65+
<br></br>
66+
67+
:::info Need Help?
68+
If you encounter any issues or have questions about our API, please don't hesitate to reach out through our relevant [**community support channels**](/community/support).
69+
:::

website/src/components/SiteMap/index.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ const products: Product[] = [
4848
{ title: 'Deployment Guides', link: '/guides/deployment-guide/', description: 'Deploying to Production', category: 'platform' },
4949
{ title: 'Administration Guides', link: '/guides/administration-guides/', description: 'Management and Customization', category: 'platform' },
5050
{ title: 'User Guides', link: '/guides/user-guides/', description: 'Interacting with the Platorm', category: 'platform' },
51-
{ title: 'API Guide', link: '/guides/api-guides', description: 'Interacting with the Platorms APIs', category: 'platform' },
51+
{ title: 'API Reference', link: '/guides/api-guides', description: 'Interacting with the Platorms APIs', category: 'platform' },
5252
{ title: 'Song', link: 'docs/core-software/song/overview', image: iconSong, description: 'Metadata Management Service', category: 'core' },
5353
{ title: 'Score', link: '/docs/core-software/score/overview', image: iconScore, description: 'File Transfer Service', category: 'core' },
5454
{ title: 'Maestro', link: '/docs/core-software/maestro/overview', image: iconMaestro, description: 'Metadata Indexing Service', category: 'core' },

0 commit comments

Comments
 (0)