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.
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
Api definition guidelines #71
Api definition guidelines #71
Changes from 11 commits
914fa3c
0181d0d
b02d87a
88256c0
dee4d60
f32fbc5
570697c
18cdcf1
02b5a19
20fb26e
aba535b
f67ffff
a90d70b
e486715
39579d0
12ae3a0
5aff3e2
File filter
Filter by extension
Conversations
Jump to
There are no files selected for viewing
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.
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.
I would prefer specification over definitions
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.
@hickeyma, can you elaborate on that preference in light of the definition vs specification article? My thought is that this new repo would explicitly house
definitions
(for machine consumption). Are you thinking that it would also housespecifications
(for human consumption)?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.
Just to weigh in, the Kubernetes community often uses "spec" to define the API specification. I've seen "model" being used elsewhere. I'm ok with both TBH.
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.
Ah, good point. I think you're right that the
kubernetes
community usesspec
in this context a lot. I do think it's also a little muddy withCustomResourceDefinition
which is the thing that defines theschema
for a "thing" and thenspec
being the canonical name for the field within thatschema
where a user would create an instance of that "thing." I that vein, it still feels likeDefinition
is the consistent word where theschema
is defined.That said, I'm a big fan of putting a
Cares About
number (1-10) on this kind of opinion and then just taking the highest one.CA: 2
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.
Looks like we went with
instructlab/openai
. I'm fine with that.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.
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.
Same question as above. Why the preference for
specification
vsdefinition
if the explicit goal of the repo is to own machine-consumabledefinitions
. Are you thinking that theyaml
format is the human-readablespecification
vs the generated language-specific packages are the machine-readabledefinitions
?