Skip to content
This repository has been archived by the owner on Apr 16, 2021. It is now read-only.

HTTP API Specification #63

Closed
wants to merge 8 commits into from
Closed

Conversation

RichardLitt
Copy link
Contributor

Working on the HTTP API Spec introduction blogpost

@RichardLitt
Copy link
Contributor Author

RichardLitt commented Jul 1, 2016

This pertains to issue #62


### 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.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

API Bluebprint < typo

@RichardLitt
Copy link
Contributor Author

This should look a lot better now!

@whyrusleeping Can you help me out: what is a swarm address? How does that look?

@whyrusleeping
Copy link
Contributor

A swarm address is a multiaddr

@daviddias
Copy link
Contributor

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.

@RichardLitt
Copy link
Contributor Author

That's fair. I think that the current HTTP API is useful, but I'm biased.

@jbenet What do you think?

@daviddias
Copy link
Contributor

Closing ancient posts that never got posted.

@daviddias daviddias closed this Jul 27, 2018
@ghost ghost removed the stage: review label Jul 27, 2018
@daviddias daviddias deleted the feature/http-api-skeleton branch July 27, 2018 13:15
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants