Comments (9)
I will go through the list once again and see if anything is missing.
If you (or anyone else upgrading libraries to v1.1) notice that anything is missing, please create an issue.
In general, v1.1 does not contain any breaking changes. It only contains additions, clarifications, and wording improvements. This may be the reason that the changelog is smaller than you expect.
from json-api.
No. It's not the fear for breaking changes.
It's the fear that my software will become more and more feature incomplete over time simply because I can't track updates reliably.
from json-api.
There is a brief summary of changes provided as update history. It's part of the about page. Not very easy to discover.
Is this what you are talking about? Or are you looking for way more detailed changelog?
from json-api.
I've already seen this, and I'm not sure it carries all I (and others) need. I don't know if this list is definitive/complete.
I maintain an open source repo - json-api-formatter - and in order to upgrade the code to 1.1 compliance, I'd need a list of all changes, else I have to go through the entire spec, line by line, hoping to notice differences.
As per the php8.1, I can clearly see the new features.
There is also a specific updates section.
Even if it's just a definitive list (with the detail in the spec) this would still be useful.
from json-api.
I noticed that there is additional context on the motivation behind this request in the forum thread:
It says โNew features includeโ. This implies to me that it is not all changes, just interesting ones.
I interpret that the fear that other breaking changes may be missing in that list. Copying my reply from the forum here as well:
v1.1 does not include any breaking changes.
It includes some additional clarifications and improvements in wording. Such changes could be shipped any time even to a version, which has been published already. We have done it a lot over v1.0 lifecycle.
From an implementation perspective only the new features should be relevant. Unless there is a bug in the implementation caused by unclear wording of the specification previously. But that would not be related to v1.1 release.
Does that resolve the need for a more detailed update list?
from json-api.
It's the fear that my software will become more and more feature incomplete over time simply because I can't track updates reliably.
The updates list in history covers all new features.
Also I wouldn't be too afraid that you miss important features. I'm sure that consumers of your library will request support for those features if they need them. ๐
from json-api.
Your use of language is "... a brief summary of changes...". To me that implies an overview/summary.. which does not contain detail and would omit items.
Are you confirming that this a complete list (even if not detailed)?
The ambiguity would be changed by changing the text to say: "a brief summary of all changes".
Regarding users - sure, but it could also cause a person to ignore the software in the first place: this would be invisible to me. Not everyone wants to contribute like us! :)
from json-api.
(and to be clear: if it is all changes, that is completely satisfactory!)
from json-api.
The updates list in history covers all new features.
Usually new versions should come with post with what the new changes will let the users do, and what problem it is going to address over the older version.
from json-api.
Related Issues (20)
- Allow custom resource links HOT 13
- Why the square bracket syntax for query params? HOT 7
- consider support for implementation-specific members HOT 2
- JSON-LD integration example HOT 1
- Clarify intent of links member HOT 1
- How does one document a JSON:API HOT 4
- 1.1 spec disallows e.g. filter[author.name] HOT 4
- Inclusion of related resources for heterogeneous collections
- PrimaryResourceType not to be null at this point HOT 1
- Create/update relationships having attributes? HOT 3
- ember-data link on implementations page is broken HOT 2
- Bulk delete as either extention or implementation HOT 4
- Extend Spec To Allow Creation of Multiple Resources in One API Call HOT 1
- Profiles should be allowed to define query parameters HOT 5
- JSONRenderer does not extract includes from PolymorphicModelSerializer properly HOT 1
- Version 1.1 is incomplete about where extension members are allowed.
- Suggestion: Add GitHub topics to help with discoverability
- Semantics of PATCHing attributes HOT 8
- Explain intent of local identifiers in a note in the spec
- https://jsonapi.org/schema#/definitions/failure 404 error
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. ๐๐๐
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google โค๏ธ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from json-api.