Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Get docusaurus building #1434

Open
wants to merge 3 commits into
base: fdc3-for-web-impl
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 1 addition & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,7 @@ website/build/
website/static/toolbox
website/node_modules
website/i18n/*
website/package-lock.json
website/.docusaurus/**
website/.docusaurus/
test-results.xml


Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Accepts an optional `app` parameter in order to specify a specific app.

## Schema

<https://fdc3.finos.org/schemas/next/context/action.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/action.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/action.schema.json> ([github](static/schemas/2.1/context/action.schema.json))
kriswest marked this conversation as resolved.
Show resolved Hide resolved

## Type

Expand Down Expand Up @@ -53,7 +53,9 @@ A context object with which the action will be performed
<details>
<summary><code>app</code></summary>

**type**: api/AppIdentifier
**All of:**

- **type**: api/AppIdentifier

An optional target application identifier that should perform the action

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ In addition to handling requests to plot charts, a charting application may use

## Schema

<https://fdc3.finos.org/schemas/next/context/chart.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chart.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/chart.schema.json> ([github](static/schemas/2.1/context/chart.schema.json))

## Type

Expand All @@ -44,7 +44,9 @@ An array of instrument contexts whose data should be plotted.
<details>
<summary><code>range</code></summary>

**type**: [TimeRange](TimeRange)
**All of:**

- **type**: [TimeRange](TimeRange)

The time range that should be plotted

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A collection of settings to start a new chat conversation

## Schema

<https://fdc3.finos.org/schemas/next/context/chatInitSettings.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatInitSettings.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/chatInitSettings.schema.json> ([github](static/schemas/2.1/context/chatInitSettings.schema.json))

## Type

Expand Down Expand Up @@ -39,7 +39,7 @@ Contacts to add to the chat
<details>
<summary><code>message</code></summary>

**One of:**
**Any of:**

- **type**: `string`
- **type**: [Message](Message)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: ChatMessage
sidebar_label: ChatMessage
title: Chat Message
sidebar_label: Chat Message

---

# ChatMessage
# Chat Message

A context representing a chat message. Typically used to send the message or to pre-populate a message for sending.

## Schema

<https://fdc3.finos.org/schemas/next/context/chatMessage.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatMessage.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/chatMessage.schema.json> ([github](static/schemas/2.1/context/chatMessage.schema.json))

## Type

Expand All @@ -21,7 +21,7 @@ A context representing a chat message. Typically used to send the message or to
<details>
<summary><code>chatRoom</code> <strong>(required)</strong></summary>

**type**: [ChatRoom](ChatRoom)
**type**: [Chat Room](ChatRoom)

</details>

Expand All @@ -30,6 +30,8 @@ A context representing a chat message. Typically used to send the message or to

**type**: [Message](Message)

The content of the message to post in the chat when created.

</details>

## Example
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: ChatRoom
sidebar_label: ChatRoom
title: Chat Room
sidebar_label: Chat Room

---

# ChatRoom
# Chat Room

Reference to the chat room which could be used to send a message to the room

## Schema

<https://fdc3.finos.org/schemas/next/context/chatRoom.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatRoom.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/chatRoom.schema.json> ([github](static/schemas/2.1/context/chatRoom.schema.json))

## Type

Expand All @@ -32,13 +32,6 @@ The name of the service that hosts the chat

**type**: `object`

<details>
<summary><code>Additional Properties</code></summary>

**type**: `string`

</details>

Identifier(s) for the chat - currently unstandardized

</details>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
---
title: ChatSearchCriteria
sidebar_label: ChatSearchCriteria
title: Chat Search Criteria
sidebar_label: Chat Search Criteria

---

# ChatSearchCriteria
# Chat Search Criteria

A context type that represents a simple search criterion, based on a list of other context objects, that can be used to search or filter messages in a chat application.

## Schema

<https://fdc3.finos.org/schemas/next/context/chatSearchCriteria.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/chatSearchCriteria.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/chatSearchCriteria.schema.json> ([github](static/schemas/2.1/context/chatSearchCriteria.schema.json))

## Type

Expand All @@ -26,20 +26,13 @@ A context type that represents a simple search criterion, based on a list of oth
<details>
<summary><code>Items</code></summary>

<summary><code>Search Criteria</code></summary>

**One of:**
**Any of:**

- **type**: [Instrument](Instrument)
- **type**: [Organization](Organization)
- **type**: [Contact](Contact)
- **type**: `string`

An individual criteria against which to match chat messages, based on an FDC3 context or free-text string.




</details>

An array of criteria that should match chats returned from by a search.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A person contact that can be engaged with through email, calling, messaging, CMS

## Schema

<https://fdc3.finos.org/schemas/next/context/contact.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/contact.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/contact.schema.json> ([github](static/schemas/2.1/context/contact.schema.json))

## Type

Expand Down Expand Up @@ -47,15 +47,6 @@ Identifiers that relate to the Contact represented by this context

</details>

<details>
<summary><code>name</code></summary>

**type**: `string`

An optional human-readable name for the contact

</details>

## Example

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,39 +12,14 @@ The contact list schema does not explicitly include identifiers in the `id` sect

## Schema

<https://fdc3.finos.org/schemas/next/context/contactList.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/contactList.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/contactList.schema.json> ([github](static/schemas/2.1/context/contactList.schema.json))

## Type

`fdc3.contactList`

## Properties

<details>
<summary><code>id</code></summary>

**type**: `object`

<details>
<summary><code>Additional Properties</code></summary>

**type**: `string`

</details>

One or more identifiers that refer to the contact list in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future.

</details>

<details>
<summary><code>name</code></summary>

**type**: `string`

An optional human-readable summary of the contact list

</details>

<details>
<summary><code>contacts</code> <strong>(required)</strong></summary>

Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Notes:

## Schema

<https://fdc3.finos.org/schemas/next/context/country.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/country.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/country.schema.json> ([github](static/schemas/2.1/context/country.schema.json))

## Type

Expand Down Expand Up @@ -71,15 +71,6 @@ Three-letter ISO country code. Deprecated in FDC3 2.0 in favour of the version p

</details>

<details>
<summary><code>name</code></summary>

**type**: `string`

An optional human-readable name for the country

</details>

## Example

```json
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A context representing an individual Currency.

## Schema

<https://fdc3.finos.org/schemas/next/context/currency.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/currency.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/currency.schema.json> ([github](static/schemas/2.1/context/currency.schema.json))

## Type

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ A collection of information to be used to initiate an email with a Contact or Co

## Schema

<https://fdc3.finos.org/schemas/next/context/email.schema.json> ([github](https://github.com/finos/FDC3/tree/main/schemas/context/email.schema.json))
<https://fdc3.finos.org/schemas/2.1/context/email.schema.json> ([github](static/schemas/2.1/context/email.schema.json))

## Type

Expand Down
Loading
Loading