Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Design link to API documentation #624

Closed
2 tasks done
kyyberi opened this issue Nov 12, 2015 · 5 comments
Closed
2 tasks done

Design link to API documentation #624

kyyberi opened this issue Nov 12, 2015 · 5 comments
Assignees
@55
Labels
enhancement
Milestone
Sprint 17

Comments

@kyyberi
Copy link

kyyberi commented Nov 12, 2015

User story

As a API owner and API consumer I want to access API documentation which can a link to external site or build-in swagger.

additional info

I added Lentodiilit API and link to documentation but it's not visible anywhere.

Definition of done

  • View API backend should display a link to documentation whether it is external documentation or a Swagger file in Apinf.
  • If both are provided, it should display both.
@bajiat bajiat changed the title Link to API documentation missing Design link to API documentation Nov 20, 2015
@bajiat bajiat added enhancement and removed bug labels Nov 20, 2015
@bajiat
Copy link
Contributor

bajiat commented Nov 23, 2015

@elnzv This should be a fairly small design task. Could you take this one along with the bigger implementation task (settings)?

@55
Copy link
Contributor

55 commented Nov 24, 2015

Okay, taking this task.

@55 55 self-assigned this Nov 24, 2015
@55 55 added ready and removed planning labels Nov 24, 2015
@brylie brylie added this to the Sprint 17 milestone Nov 24, 2015
@55 55 added in progress and removed ready labels Dec 3, 2015
@55
Copy link
Contributor

55 commented Dec 3, 2015

doc_links

If there is no documentation attached - block is hidden.

Also uploaded to docs repo.
https://github.com/apinf/docs/blob/master/docs/design/%23624_link_to_API_documentation.gif

@apinf/design, please review and close this issue.

@kyyberi
Copy link
Author

kyyberi commented Dec 6, 2015

I would try tabbed content here too. I have a gut feeling the content will expand and with current design people are forced to scroll and most hate it nowadays.

@kyyberi
Copy link
Author

kyyberi commented Dec 6, 2015

Related to #664

@55 55 closed this as completed Dec 7, 2015
@55 55 removed the in progress label Dec 7, 2015
@brylie brylie mentioned this issue May 10, 2016
Closed
5 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@55 55

Labels
enhancement
Projects
None yet
Milestone
Sprint 17
Development

No branches or pull requests
4 participants
@brylie @kyyberi @55 @bajiat