You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
The project should better demarcate what is API and what is not #284
Currently it is not crystal clear what is API and what is not.
Clearly top level classes such as GraphQL and ExecutionStrategy are API
But what about graphql.execution.Execution or graphql.execution.ValuesResolver. Are they API or implementation detail?
If we had to add new aspects to these classes and changed constructors etc are we breaking consumers?
I suggest that the API be made more clear.
Annotations are a great way to do this. The project could have 3 new annotations
@publicapi (things you can call and wont change)
@PublicSPI (things you are meant to implement) @internal (public things that are not API and may change)
This will allow the project to better keep semver sematics while evolving as necessary.
Reacted by Dmitry Minkovsky, Sean Brandt, kreed-rmn and Alexander Galushka
Activity
jimexist commentedon Dec 26, 2016
regarding
@Internali think puttinginternalin package name is a good practicebbakerman commentedon Dec 28, 2016
I agree on .internal in the package name as well as .api in the packages however that would be a major breaking change.
Ideally it would be
and
the use of annotations are a way to not break current API while better documenting what is API
andimarek commentedon Apr 8, 2017
Because we are planning for a breaking change release I suggest that we use that to try to make it more clear what api vs internal is.
But I think moving everything is not acceptable imho. Breaking stuff should be limited to what we think is really necessary. Annotating seems fine.
andimarek commentedon May 2, 2017
I like the idea to add two annotations
@PublicApiand@InternalApifor example.andimarek commentedon May 6, 2017
First shot: #411
andimarek commentedon May 14, 2017
we added annotations in #411 ...closing it therefore now: we will add the annotations as we go.