LBRYCommunity/lighthouse.js
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Change the API doc to swagger instead of jsdoc. #97

New issue
Closed
opened 2018-07-25 14:47:21 +02:00 by filipnyquist · 1 comment
filipnyquist commented 2018-07-25 14:47:21 +02:00 (Migrated from github.com)
Copy link

The documentation should be changed to swagger, which will make us follow the OpenAPI spec.
This will make it easier for people to make API clients and give them a better overview of the API.
The code for this is close to ready, it needs some final fixing and swagger checks.

The documentation should be changed to swagger, which will make us follow the OpenAPI spec. This will make it easier for people to make API clients and give them a better overview of the API. The code for this is close to ready, it needs some final fixing and swagger checks.
kauffj commented 2018-07-25 15:12:31 +02:00 (Migrated from github.com)
Copy link

@NetOperatorWibby please consider how we want this displayed on lbry.tech. The primary emphasis on the Resources page will be on the Whitepaper and blockchain/daemon APIs, but secondary APIs such as lighthouse will be displayed there as well.

In the abstract, I'm in favor of using the OpenAPI spec when the API being documented is RESTful.

@NetOperatorWibby please consider how we want this displayed on lbry.tech. The primary emphasis on the Resources page will be on the Whitepaper and blockchain/daemon APIs, but secondary APIs such as lighthouse will be displayed there as well. In the abstract, I'm in favor of using the OpenAPI spec when the API being documented is RESTful.
👍 2
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
timestamp-weight
chainquery-db-connection
strip_prefex
No results found.
Labels
Clear labels   
area: app c

Work is part of App C

  
area: app d

Work is part of App D

  
area: devops

   
area: discovery

   
area: docs

   
area: proposal

Work is part of a proposal

  
area: X-device Sync

Cross Device experience

  
Chainquery

This feature or fix will be possible with chainquery.

  
consider soon

Discuss this issue at the next planning meeting, then remove this label

  
dependencies

Pull requests that update a dependency file

  
Epic

   
Fix till next release

   
good first issue

   
hacktoberfest

Welcome to Hacktoberfest

  
help wanted

   
icebox

Long-term storage

  
Invalid

   
level: 1

No knowledge of the existing code required

  
level: 2

Some knowledge of the existing code is recommended

  
level: 3

Significant knowledge of the existing code is recommended

  
level: 4

Intimate knowledge of the existing code is recommended

  
needs: exploration

Solution unclear, needs research

  
needs: grooming

Issue needs to be groomed before work can start

  
needs: priority

Priority level needs to be defined

  
needs: repro

Issue needs step-by-step instructions on how to reproduce in latest code

  
needs: tech design

Needs technical design signoff before implementation can begin

  
on hold

Temporarily paused

  
Parked

on hold for a dependency or to be planned

  
priority: blocker

Issue is blocking release, do ASAP

  
priority: high

Work needs to be moved into sprint ASAP

  
priority: low

Work should be done but can stay in the backlog for now

  
priority: medium

Work needs to be done within 2-3 sprints

  
Tom's Wishlist

   
type: bug

Existing functionality is wrong or broken

  
type: discussion

A conversation. No specific changes requested

  
type: improvement

Existing (or partially existing) functionality needs to be changed

  
type: new feature

New functionality that does not exist yet

  
type: refactor

Minimal user-visible changes, but significant internal work

  
type: task

Either work that's not related to the code, or a small chore that does not fit into other categories

  
type: testing

Solution needs additional user testing

  
unplanned

Work that was not planned into the spirnt, took priority over planned work

No labels
area: app c
area: app d
area: devops
area: discovery
area: docs
area: proposal
area: X-device Sync
Chainquery
consider soon
dependencies
Epic
Fix till next release
good first issue
hacktoberfest
help wanted
icebox
Invalid
level: 1
level: 2
level: 3
level: 4
needs: exploration
needs: grooming
needs: priority
needs: repro
needs: tech design
on hold
Parked
priority: blocker
priority: high
priority: low
priority: medium
Tom's Wishlist
type: bug
type: discussion
type: improvement
type: new feature
type: refactor
type: task
type: testing
unplanned
Milestone
Clear milestone
No items
No milestone
Projects
Clear projects
No items
No project
Assignees
Clear assignees
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference: LBRYCommunity/lighthouse.js#97
No description provided.
Delete branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?