Skip to content

Commit

Permalink
feat: update networks/config example response
Browse files Browse the repository at this point in the history
  • Loading branch information
pseudoyu committed Nov 28, 2024
1 parent 1877579 commit 377ea42
Showing 1 changed file with 153 additions and 16 deletions.
169 changes: 153 additions & 16 deletions docs/schemas/NetworkConfigData.yaml
Original file line number Diff line number Diff line change
@@ -1,21 +1,158 @@
example:
data:
http2_disabled:
description: Some endpoints may not support HTTP2, set this to true to disable
HTTP2.
is_required: false
type: bool
value: null
http_headers:
description: HTTP headers to be sent with requests to this endpoint.
is_required: false
type: map[string]string
value: null
url:
description: The URL of the endpoint.
is_required: true
type: url
value: null
rss:
id: rsshub
endpoint_configs:
url:
description: Your RSSHub instance URL
is_required: true
type: url
value: null
http_headers:
description: HTTP headers to be sent with requests to this endpoint.
is_required: false
type: map[string]string
value: null
http2_disabled:
description: Some endpoints may not support HTTP2, set this to true to disable HTTP2.
is_required: false
type: bool
value: null
worker_configs:
- id:
description: Worker's id, must be unique, for example '[network]-[worker]'
is_required: true
type: string
value: rsshub-core
network:
description: The network where the worker operates on
is_required: true
type: string
value: rsshub
worker:
description: Name of the worker
is_required: true
type: string
value: core
endpoint:
description: Your RSSHub instance URL
is_required: true
type: url
value: null
parameters:
authentication:
access_key:
description: Access key to access your RSSHub
is_required: false
type: string
value: null
minimum_resource:
cpu_core: 0.25
memory_in_gb: 0.25
disk_space_in_gb: 0
decentralized:
- id: arweave
endpoint_configs:
url:
description: The URL of the endpoint.
is_required: true
type: url
value: https://arweave.net
http_headers:
description: HTTP headers to be sent with requests to this endpoint.
is_required: false
type: map[string]string
value: null
http2_disabled:
description: Some endpoints may not support HTTP2, set this to true to disable HTTP2.
is_required: false
type: bool
value: null
worker_configs:
- id:
description: Worker's id, must be unique, for example '[network]-[worker]'
is_required: true
type: string
value: arweave-mirror
network:
description: The network where the worker operates on
is_required: true
type: string
value: arweave
worker:
description: Name of the worker
is_required: true
type: string
value: mirror
ipfs_gateways:
description: A list of IPFS gateways to fetch data from, multiple gateways may improve the availability of IPFS data
is_required: true
type: []url

Check failure on line 90 in docs/schemas/NetworkConfigData.yaml

View workflow job for this annotation

GitHub Actions / generate

no-unresolved-refs

Failed to parse: bad indentation of a mapping entry in "/home/runner/work/Node/Node/docs/schemas/NetworkConfigData.yaml" (90:23)

Check failure on line 90 in docs/schemas/NetworkConfigData.yaml

View workflow job for this annotation

GitHub Actions / generate

no-unresolved-refs

Failed to parse: bad indentation of a mapping entry in "/home/runner/work/Node/Node/docs/schemas/NetworkConfigData.yaml" (90:23)
value: null
parameters:
concurrent_block_requests:
description: The number of concurrent RPC requests to the Arweave gateway. Default: 1
is_required: false
type: uint
value: 1
minimum_resource:
cpu_core: 0.5
memory_in_gb: 0.5
disk_space_in_gb: 4
federated:
- id: mastodon
endpoint_configs:
url:
description: Your Mastodon instance must be accessible via a public URL, which exposes your local instance on the port number you select. You can use services like ngrok (https://ngrok.com).
is_required: true
type: string
value: https://domain.ngrok.app
http_headers:
description: HTTP headers to be sent with requests to this endpoint.
is_required: false
type: map[string]string
value: null
http2_disabled:
description: Some endpoints may not support HTTP2, set this to true to disable HTTP2.
is_required: false
type: bool
value: null
worker_configs:
- id:
description: Worker's id, must be unique, for example '[network]-[worker]'
is_required: true
type: string
value: mastodon-core
network:
description: The network where the worker operates on
is_required: true
type: string
value: mastodon
worker:
description: Name of the worker
is_required: true
type: string
value: core
endpoint:
description: Your Mastodon instance must be accessible via a public URL, which exposes your local instance on the port number you select. You can use services like ngrok (https://ngrok.com).
is_required: true
type: string
value: mastodon
parameters:
relay_url_list:
description: List of relay URLs to follow and receive messages from
is_required: false
type: []url
value: null
port:
description: The port number that the mastodon endpoint domain will listen on. This should be an available network port
is_required: false
type: uint
value: null
minimum_resource:
cpu_core: 0.5
memory_in_gb: 0.5
disk_space_in_gb: 12
properties:
data:
$ref: "./NetworkConfig.yaml"
Expand Down

0 comments on commit 377ea42

Please sign in to comment.