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.

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

Create HTTP document #304

Open
6 tasks
salmad3 opened this issue Jan 22, 2023 · 0 comments
Open
6 tasks

Create HTTP document #304

salmad3 opened this issue Jan 22, 2023 · 0 comments
Labels
area:http P2 Medium type:new page New content page

Comments

@salmad3
Copy link
Member

salmad3 commented Jan 22, 2023

Context

As a successor to the recent discussions and idea generation around integrating HTTP with libp2p, the libp2p stewards are defining a formal specification for HTTP in libp2p. A technical document is needed to explain the details of this integration to users and developers.

  • The working draft of the specification is currently in progress and can be found at add HTTP spec specs#508.
  • The goal is to also have at least one reference implementation for this specification.

Done Criteria

  • A user-friendly overview of libp2p + HTTP
  • A clear explanation of the problem or challenge in libp2p that this integration aims to address, such as limitations of traditional libp2p connections and the need for nodes to be able to offer services via HTTP.
  • A note indicating how existing request-response semantics can be mapped onto HTTP.
  • An explanation of how this integration will affect nodes that are already running, including any changes to connection types or other considerations that need to be taken into account.
  • A summary of the benefits of using HTTP in libp2p, such as increased accessibility and improved performance.
  • Identification of the best location for the document to exist, with the goal of ensuring that it is easily accessible and scalable for future updates.

Why Important

  • It is essential for readers to understand the abstraction layer that libp2p provides beyond ordered, reliable, and secure streams.
  • This document will inform users and developers about the new HTTP functionality in libp2p and make them aware of this capability.
@salmad3 salmad3 added P1 High type:new page New content page area:http labels Jan 22, 2023
@salmad3 salmad3 moved this to 🥞 Todo in go-libp2p Jan 22, 2023
@salmad3 salmad3 moved this to Planned in libp2p Product Jan 22, 2023
@salmad3 salmad3 self-assigned this Jan 24, 2023
@salmad3 salmad3 added P2 Medium and removed P1 High labels Jan 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:http P2 Medium type:new page New content page
Projects
Status: 🥞 Todo
Status: Planned
Development

No branches or pull requests

1 participant