This repository was archived by the owner on Apr 7, 2025. It is now read-only.
RFC: API-v2 - Standardized and Fully Documented API #224
Conversation
This file contains hidden or 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
AleksandarCole
requested review from
DamjanBecirovic,
darkofabijan,
hamir-suspect,
lucaspin and
radwo
lucaspin
reviewed
Oct 3, 2024
|
|
||
| [Timestamps](#timestamps) | ||
|
|
||
| ## Introduction {#introduction} |
Contributor
There was a problem hiding this comment.
Do we need the {#...} part in the headers?
Contributor
There was a problem hiding this comment.
I'll just use this comment thread to make a note about the formatting:
- Table of contents should be re-formatted.
- Code blocks in this file should be properly formatted too.
Tasks and Project Webhooks can be restructured as Project Triggers, including support for external triggers beyond webhooks.
| "result": "STOPPED", | ||
| "state": "FINISHED" | ||
|
|
||
| "timeline": { |
Contributor
There was a problem hiding this comment.
so we do not have the final decision here wether to put timeline in status or metadata?
Member
There was a problem hiding this comment.
for "live" resources timeline will be in status, and we will keep base timestamps in metadata
| }, | ||
| "spec": { | ||
| "agent": { | ||
| "ports": [{ |
Contributor
There was a problem hiding this comment.
agent ports should be in status -> agent as is the ip address.
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.
This PR introduces the initial RFC for API-v2, a project aimed at standardizing our API structure and implementing comprehensive documentation for all endpoints.
Key points:
This RFC outlines the motivation, proposed solutions, and open questions for discussion.