Closes #49, with CSS fixes

This commit is contained in:
ポール ウェッブ 2018-05-22 14:57:34 -05:00
parent 47b261a7a4
commit ba7b18c144
5 changed files with 160 additions and 6 deletions

View file

@ -4,6 +4,10 @@
padding-top: 2rem;
}
h4 + h2 {
padding-top: 2rem;
}
.blog-post {
a {
display: inline-block;

View file

@ -25,15 +25,18 @@
.page__header__title {
font-weight: 300;
line-height: 6.5rem;
text-shadow: 1px 1px 2px rgba($black, 0.3);
@media (min-width: 901px) {
font-size: 3rem;
line-height: 6.5rem;
}
@media (max-width: 900px) {
font-size: 2rem;
line-height: 1;
padding-top: 1rem;
padding-bottom: 1rem;
}
}
@ -165,11 +168,30 @@
pre {
margin-bottom: 2rem; padding: 2rem;
background-color: $black;
border-radius: 3px;
color: $white;
font-size: 1rem;
line-height: 1.33;
overflow-x: auto;
overflow-y: hidden;
&:not([class]),
&.language-text {
background-color: $black;
color: $white;
}
&.language-yaml {
background-color: #27273f;
color: #ffe066;
.atrule {
color: #f083ac;
}
.punctuation {
color: $white;
}
}
}
table {

View file

@ -120,10 +120,28 @@
<h1>API Specification</h1>
<h4>All of our APIs, in one place</h4>
<h2>chainquery</h2>
<ul>
<li><a href="https://github.com/lbryio/chainquery">chainquery</a></li>
<li><a href="https://lbry.io/api">JSON-RPC</a></li>
<li><a href="https://lbryio.github.io/lighthouse">Lighthouse</a></li>
<li><a href="https://github.com/lbryio/chainquery">Codebase</a></li>
<li><a href="">OpenAPI signature</a></li>
</ul>
<h2>lbry</h2>
<ul>
<li><a href="https://lbry.io/api">Codebase</a></li>
<li><a href="/open-api/lbry.html">OpenAPI signature</a></li>
</ul>
<h2>lbrycrd</h2>
<ul>
<li><a href="https://github.com/lbryio/lbrycrd">Codebase</a></li>
<li><a href="/open-api/lbrycrd.html">OpenAPI signature</a></li>
</ul>
<h2>Lighthouse</h2>
<ul>
<li><a href="https://lbryio.github.io/lighthouse">Codebase</a></li>
<li><a href="">OpenAPI signature</a></li>
</ul>
<h1>The Front Desk</h1>

55
open-api/lbry.md Normal file
View file

@ -0,0 +1,55 @@
---
title: LBRY OpenAPI Specification
---
```yaml
openapi: "3.0.0"
info:
version: 1.0.0
title: LBRY
license:
name: MIT
servers:
- url: http://lbry.swagger.io/v1
paths:
/blob_announce:
get:
summary: Announce blobs to the DHT
operationId: blobAnnounce
tags:
- blob
parameters:
- name: blob_hash
in: query
description: announce a blob, specified by blob_hash
required: false
schema:
type: string
- name: stream_hash
in: query
description: announce all blobs associated with stream_hash
required: false
schema:
type: string
- name: sd_hash
in: query
description: announce all blobs associated with sd_hash and the sd_hash itself
required: false
schema:
type: string
responses:
true:
description: A paged array of pets
content:
application/json:
schema:
$ref: "#/components/schemas/Blob"
default:
description: unsuccessful announcement
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
```

55
open-api/lbrycrd.md Normal file
View file

@ -0,0 +1,55 @@
---
title: LBRYcrd OpenAPI Specification
---
```yaml
openapi: "3.0.0"
info:
version: 1.0.0
title: LBRYcrd
license:
name: MIT
servers:
- url: http://lbrycrd.swagger.io/v1
paths:
/blob_announce:
get:
summary: Announce blobs to the DHT
operationId: blobAnnounce
tags:
- blob
parameters:
- name: blob_hash
in: query
description: announce a blob, specified by blob_hash
required: false
schema:
type: string
- name: stream_hash
in: query
description: announce all blobs associated with stream_hash
required: false
schema:
type: string
- name: sd_hash
in: query
description: announce all blobs associated with sd_hash and the sd_hash itself
required: false
schema:
type: string
responses:
true:
description: A paged array of pets
content:
application/json:
schema:
$ref: "#/components/schemas/Blob"
default:
description: unsuccessful announcement
content:
application/json:
schema:
$ref: "#/components/schemas/Error"
```