Aggregator - Revision history

Tim: .

2024-03-14T22:30:45Z

← Older revision		Revision as of 18:30, 14 March 2024
Line 1:		Line 1:
	An aggregator is an HTTP server that hosts a database of [[ZWI]] files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link].		An aggregator is an HTTP server that hosts a database of [[ZWI]] files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link]. Two aggregators are [[EncycloSearch]] and [[EncycloReader]].

	== Downloading files from an aggregator ==		== Downloading files from an aggregator ==

Hampson at 02:35, 23 February 2024

2024-02-23T02:35:23Z

← Older revision		Revision as of 22:35, 22 February 2024
Line 1:		Line 1:
	An aggregator is an HTTP server that hosts a database of ZWI files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link].		An aggregator is an HTTP server that hosts a database of [[ZWI]] files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link].

	== Downloading files from an aggregator ==		== Downloading files from an aggregator ==
	The database is hosted at <code><aggregator URL>/encyclosphere/database</code>. Visiting <code><aggregator URL>/encyclosphere/database</code> in your browser should display an overview of the database.		The database is hosted at <code><aggregator URL>/encyclosphere/database</code>. Visiting <code><aggregator URL>/encyclosphere/database</code> in your browser should display an overview of the database.

	To download a file, you must first find its location in the database. To find the file you're looking for, refer to the database section of the documentation.		To download a file, you must first find its location in the [[database]]. To find the file you're looking for, refer to the database section of the documentation.

	Once you've got the location, here's how you download it. Say the path in the database is <code>en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>. To download it, make a GET request to <code><aggregator URL>/encyclosphere/database/en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>.		Once you've got the location, here's how you download it. Say the path in the database is <code>en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>. To download it, make a GET request to <code><aggregator URL>/encyclosphere/database/en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>.

Hampson: Created page with "An aggregator is an HTTP server that hosts a database of ZWI files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link]. == Downloading files from an aggregator == The database is hosted at `/encyclosphere/database`. Visiting `/encyclosphere/database` in your browser should display an overview of the database. To download a file, you must first find its location in the databas..."

2024-02-21T21:22:21Z

Created page with "An aggregator is an HTTP server that hosts a database of ZWI files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link]. == Downloading files from an aggregator == The database is hosted at <code><aggregator URL>/encyclosphere/database</code>. Visiting <code><aggregator URL>/encyclosphere/database</code> in your browser should display an overview of the database. To download a file, you must first find its location in the databas..."

New page

An aggregator is an HTTP server that hosts a database of ZWI files. More documentation can be found at [https://docs.encyclosphere.org/#/aggregators this link].

== Downloading files from an aggregator ==
The database is hosted at <code><aggregator URL>/encyclosphere/database</code>. Visiting <code><aggregator URL>/encyclosphere/database</code> in your browser should display an overview of the database.

To download a file, you must first find its location in the database. To find the file you're looking for, refer to the database section of the documentation.

Once you've got the location, here's how you download it. Say the path in the database is <code>en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>. To download it, make a GET request to <code><aggregator URL>/encyclosphere/database/en/handwiki/handwiki.org/wiki#Encyclosphere.zwi</code>.

== Uploading files to an aggregator ==
To upload a file to an aggregator, make a <code>POST</code> request to <code><aggregator URL>/encyclosphere/upload/</code>. The trailing slash (slash at the end of the URL) is required.

The <code>Content-Type</code> must be <code>multipart/form-data</code>. One part, named <code>zwi</code>, contains the ZWI itself. The other part, named <code>pass</code>, contains the password, if required. Example:
<code>POST /encyclosphere/upload/ HTTP/1.1
...
Content-Type: multipart/form-data; boundary=---------------------------Boundary

---------------------------Boundary
Content-Disposition: form-data; name="zwi"; filename="Knowledge.zwi"
Content-Type: application/zip

<ZWI contents>

---------------------------Boundary
Content-Disposition: form-data; name="pass"
Content-Type: text/plain

0123456789

---------------------------Boundary</code>

==== Response ====
Successful upload:
<code>{
"Success": true
}</code>
Failed upload:
<code>{
"Success": false,
"Reason": "Invalid signature"
}</code>
<code>Success</code> indicates whether the upload was successful.

<code>Reason</code>, only present if the upload failed, indicates why it failed.