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

RFC: REST Node API #27

Merged
merged 137 commits into from
Dec 15, 2021
Merged

RFC: REST Node API #27

merged 137 commits into from
Dec 15, 2021

Conversation

samuel-rufi
Copy link
Member

@samuel-rufi samuel-rufi commented Sep 10, 2020

@samuel-rufi samuel-rufi changed the title OpenAPI specification for REST API REST API OpenAPI documentation Sep 10, 2020
@samuel-rufi samuel-rufi changed the title REST API OpenAPI documentation REST API documentation Sep 10, 2020
@laumair

This comment has been minimized.

Copy link
Member

@luca-moser luca-moser left a comment

Choose a reason for hiding this comment

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

  • I believe we should rename /transaction-messages to just /transactions. For example, routes like /transaction-messages/by-address include the word messages for no apparent reason.
  • post examples still use post- where they should be get-
  • Responses should return array of objects instead of objects where each sub object is keyed by the identifier of the particular entity.
  • I am not sure whether the peers count in the /info response is useful information.
  • The API does not describe any kind of authentication mechanism which I believe at the end we should have, perhaps something simple like a JWT.

text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
@luca-moser luca-moser changed the title REST API documentation RFC: REST Node API Sep 21, 2020
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
text/0026-rest-api/rest-api.yaml Outdated Show resolved Hide resolved
@lzpap lzpap merged commit 859f971 into iotaledger:main Dec 15, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet