LBRYCommunity/lbry.tech
1
0
Fork 0
Code Issues 13 Pull requests 8 Projects Releases Packages Wiki Activity

Generate API examples for .tech #139

New issue
Closed
opened 2018-08-30 23:16:20 +02:00 by alyssaoc · 14 comments
alyssaoc commented 2018-08-30 23:16:20 +02:00 (Migrated from github.com)
Copy link

As a user of the https://lbry.tech/resources api pages, I would like to see examples from the api call on the page.

@tzarebczan Please take a look and see how best to break this up, after vacation

As a user of the https://lbry.tech/resources api pages, I would like to see examples from the api call on the page. @tzarebczan Please take a look and see how best to break this up, after vacation
tzarebczan commented 2018-08-30 23:28:05 +02:00 (Migrated from github.com)
Copy link

Those examples should be on the api pages themselves, which would come from the same place that the api data does (I think?). Some of them would also be covered in the tour.

Those examples should be on the api pages themselves, which would come from the same place that the api data does (I think?). Some of them would also be covered in the tour.
NetOpWibby commented 2018-08-30 23:55:16 +02:00 (Migrated from github.com)
Copy link

Yeah, the resources page is not the place for examples. The right side of entries on the API pages need examples: https://lbry.tech/api/protocol

Yeah, the resources page is not the place for examples. The right side of entries on the API pages need examples: https://lbry.tech/api/protocol
alyssaoc commented 2018-08-31 00:00:02 +02:00 (Migrated from github.com)
Copy link

@tzarebczan and @NetOperatorWibby Yes sorry, I went up a level because we need them for both blockchain and protocol

@tzarebczan and @NetOperatorWibby Yes sorry, I went up a level because we need them for both blockchain and protocol
lyoshenka commented 2018-09-08 04:15:22 +02:00 (Migrated from github.com)
Copy link

can't have "ready for work" and "needs: grooming" at the same time

can't have "ready for work" and "needs: grooming" at the same time
tzarebczan commented 2018-10-11 06:28:50 +02:00 (Migrated from github.com)
Copy link

The examples should come from the generated docs, so on each repo we'll have a related issue.

lbrynet: https://github.com/lbryio/lbry/issues/1334
lbrycrd: https://github.com/lbryio/lbrycrd/issues/219

The examples should come from the generated docs, so on each repo we'll have a related issue. lbrynet: https://github.com/lbryio/lbry/issues/1334 lbrycrd: https://github.com/lbryio/lbrycrd/issues/219
tzarebczan commented 2019-01-18 19:24:02 +01:00 (Migrated from github.com)
Copy link

working with @eukreign to try to get an output sample before he has the script completed.

working with @eukreign to try to get an output sample before he has the script completed.
tzarebczan commented 2019-01-21 22:22:23 +01:00 (Migrated from github.com)
Copy link

@NetOperatorWibby - see https://gist.github.com/tzarebczan/1af2e79ba365a006d1b1f0079a3cb03c for the example output from the SDK team. "output": "(map) added account details" will be replaced later on via a script with an actual output that's run during unit tests.

Hoping the blockchain team can do something similar: https://github.com/lbryio/lbrycrd/issues/219

@NetOperatorWibby - see https://gist.github.com/tzarebczan/1af2e79ba365a006d1b1f0079a3cb03c for the example output from the SDK team. "output": "(map) added account details" will be replaced later on via a script with an actual output that's run during unit tests. Hoping the blockchain team can do something similar: https://github.com/lbryio/lbrycrd/issues/219
👍 1
NetOpWibby commented 2019-01-21 23:29:12 +01:00 (Migrated from github.com)
Copy link

@tzarebczan Is this live in the repo right now? On master?

@tzarebczan Is this live in the repo right now? On master?
tzarebczan commented 2019-01-21 23:39:07 +01:00 (Migrated from github.com)
Copy link

@NetOperatorWibby, no it's in a branch until he gets the concrete examples worked out. You can access it this way: 095816781b/docs/api.json

@NetOperatorWibby, no it's in a branch until he gets the concrete examples worked out. You can access it this way: https://github.com/lbryio/lbry/blob/095816781b9df1845340ef11efbc4090b1e0faf5/docs/api.json
NetOpWibby commented 2019-01-21 23:40:01 +01:00 (Migrated from github.com)
Copy link

I'd rather wait until this is in master. The last time I focused on a non-master branch it got deleted and no one told me, which lead to .tech crashing.

I'd rather wait until this is in master. The last time I focused on a non-master branch it got deleted and no one told me, which lead to .tech crashing.
tzarebczan commented 2019-01-21 23:46:36 +01:00 (Migrated from github.com)
Copy link

Can you only include examples when that specific tag exists? We wanted to get this out with the output format so you can start working on it before a finished product is ready. Not sure where this fits in with the promotional campaign launch, but I'd rather this portion be ready when the examples tag exists in the api docs. Maybe @eukreign / @kauffj can comment further.

Can you only include examples when that specific tag exists? We wanted to get this out with the output format so you can start working on it before a finished product is ready. Not sure where this fits in with the promotional campaign launch, but I'd rather this portion be ready when the examples tag exists in the api docs. Maybe @eukreign / @kauffj can comment further.
NetOpWibby commented 2019-01-21 23:48:56 +01:00 (Migrated from github.com)
Copy link

It's not insurmountable work. IMO, if it's not in master, it's not ready.

It's not insurmountable work. IMO, if it's not in master, it's not ready.
😕 1
tzarebczan commented 2019-01-22 00:51:05 +01:00 (Migrated from github.com)
Copy link

Please verify that the format and appearance will work, not asking to go live with this. There are three different formats for calls, we'd eventually allow users to cycle through / select the one that best suites them. We can just use the lbrynet example as a first go around.

Please verify that the format and appearance will work, not asking to go live with this. There are three different formats for calls, we'd eventually allow users to cycle through / select the one that best suites them. We can just use the lbrynet example as a first go around.
kauffj commented 2019-01-25 19:37:27 +01:00 (Migrated from github.com)
Copy link

@NetOperatorWibby please confirm that this format is acceptable by testing locally

@NetOperatorWibby please confirm that this format is acceptable by testing locally
Sign in to join this conversation.
No Branch/Tag specified
Branches Tags
master
dependabot/npm_and_yarn/cacheable-request-and-got-10.2.7
dependabot/npm_and_yarn/http-cache-semantics-and-updates-4.1.1
dependabot/npm_and_yarn/json5-2.2.3
dependabot/npm_and_yarn/qs-6.5.3
dependabot/npm_and_yarn/decode-uri-component-0.2.2
trackers
dependabot/npm_and_yarn/undefsafe-2.0.5
dependabot/npm_and_yarn/node-fetch-2.6.7
dependabot/npm_and_yarn/markdown-it-12.3.2
BryanLunduke-patch-1
lbry_sdk_directory_refactor
seanyesmunt-patch-1
fix-build
lbrytv-api
devprogram-fixes
fix_some_bugs
android-build-steps-update
No results found.
Labels
Clear labels   
area: devops

   
area: discovery

   
area: docs

   
area: livestream

   
area: proposal

Work is part of a proposal

  
campaign-blocker

   
consider soon

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

  
Content

   
dependencies

Pull requests that update a dependency file

  
Epic

   
good first issue

Good for newcomers

  
hacktoberfest

Welcome to Hacktoberfest

  
help wanted

Extra attention is needed

  
icebox

Long-term storage

  
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

  
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

  
resilience

   
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: devops
area: discovery
area: docs
area: livestream
area: proposal
campaign-blocker
consider soon
Content
dependencies
Epic
good first issue
hacktoberfest
help wanted
icebox
level: 1
level: 2
level: 3
level: 4
needs: exploration
needs: grooming
needs: priority
needs: repro
needs: tech design
on hold
priority: blocker
priority: high
priority: low
priority: medium
resilience
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/lbry.tech#139
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?