Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
L
librehost api
Manage
Activity
Members
Labels
Plan
Issues
0
Issue boards
Milestones
Wiki
Code
Merge requests
0
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Ceda EI
librehost api
Commits
342941db
Commit
342941db
authored
5 years ago
by
Ceda EI
Browse files
Options
Downloads
Patches
Plain Diff
Add explanation for librehost.json keys in README
Move version next to @schema in librehost.json.
parent
0515ead6
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
README.md
+31
-1
31 additions, 1 deletion
README.md
librehost.json
+3
-3
3 additions, 3 deletions
librehost.json
with
34 additions
and
4 deletions
README.md
+
31
−
1
View file @
342941db
...
...
@@ -4,4 +4,34 @@ Librehost API JSON schema
Proposed format for json schema v0.0.1
This is planned to be expanded with option fields for services, locations, values and admins/people. Its expected to be available at /librehost.json
\ No newline at end of file
This is planned to be expanded with option fields for services, locations,
values and admins/people. Its expected to be available at /librehost.json
## Details
+
`@context`
(
`string`
): Set this to
`http://schema.org`
+
`version`
(
`string`
): This is the version of the schema. Do
**not**
update
this if you update your
`librehost.json`
.
+
`@type`
(
`string`
): Type of the site which the
`librehost.json`
represents.
+
`organizationType`
(
`string`
): Type of the organization.
+
`name`
(
`string`
): Name of the the organization.
+
`tagLine`
(
`string`
): The tagline of the organization.
+
`homeUrl`
(
`string`
): URL of the homepage of the organization.
+
`logo`
(
`string`
): Link to image file of the logo of the organization.
+
`description`
(
`string`
): Description of the organization.
+
`communicationLanguages`
(
`array(string)`
): Array of
[
ISO 639-1
codes
](
https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
)
of the
languages that the admins can be contacted in.
+
`contactUrl`
(
`string`
): URL where info to contact the admins can be found or
the admins can be contacted.
+
`privacyPolicyUrl`
(
`string`
): URL where the Privacy Policy resides.
+
`termsOfServiceUrl`
(
`string`
): URL where the Terms of Service reside.
+
`isServiceProvider`
(
`boolean`
): Denotes whether the said organization
provides services.
+
`foundingDate`
(
`int`
): Year of founding of the organization.
+
`dateCreated`
(
`string`
):
[
ISO Date Time
String
](
https://en.wikipedia.org/wiki/ISO_8601
)
(
`YYYY-MM-DDTHH:MM:SSZ`
in
UTC) denoting when the file was created.
+
`dateModified`
(
`string`
): ISO Date Time String denoting when the file was
last modified. Update this line everytime you make a change to the
`librehost.json`
.
This diff is collapsed.
Click to expand it.
librehost.json
+
3
−
3
View file @
342941db
{
"@context"
:
"http://schema.org"
,
"version"
:
"0.0.1"
,
"@type"
:
"Organization"
,
"organizationType"
:
"Informal collective"
,
"name"
:
"librehoster.example"
,
...
...
@@ -13,7 +14,6 @@
"termsOfServiceUrl"
:
"https://librehoster.example/policy/tos"
,
"isServiceProvider"
:
true
,
"foundingDate"
:
"YYYY"
,
"version"
:
"0.0.1"
,
"dateCreated"
:
"YYYY-MM-DDTHH:MM:54Z"
,
"dateCreated"
:
"YYYY-MM-DDTHH:MM:SSZ"
,
"dateModified"
:
"2018-11-10T22:32:54Z"
}
\ No newline at end of file
}
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment