This repository has been archived by the owner on Apr 16, 2021. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 48
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This pertains to issue #62 |
drafts/http-api-spec/index.md
Outdated
|
||
### Description of Apiary | ||
|
||
[Apiary](https://apiary.io) is an online service that provides a nice UI for looking at HTTP API specifications. It uses the [API Bluebprint](https://apiblueprint.org/), a simple and accessible language with concise and expressive syntax. The Apiary site reads from the [apiary.apib](https://github.com/ipfs/http-api-spec/blob/master/apiary.apib) file in the [ifps/http-api-spec](https://github.com/ipfs/http-api-spec) repository. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
API Bluebprint
< typo
This was referenced Sep 1, 2016
This should look a lot better now! @whyrusleeping Can you help me out: what is a swarm address? How does that look? |
A swarm address is a multiaddr |
Announcing an HTTP-API spec that might not be totally coherent and complete doesn't sound like a good plan. The energy should be invested on https://github.com/ipfs/http-api-spec/issues/116 first, otherwise we will be pointing our users to something that won't work for them. |
That's fair. I think that the current HTTP API is useful, but I'm biased. @jbenet What do you think? |
Closing ancient posts that never got posted. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Working on the HTTP API Spec introduction blogpost