Add `plugins.json` format version field
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 99
- Forks
- 69
- Avg merge
- 17m
- Merged PRs (30d)
- 1
Description
The plugins.json file syntax can be versioned, which allows renaming properties, for example (see this issue and this document.
The version is present in the URL, e.g. https://list-v1--netlify-plugins.netlify.app/plugins.json. However, it would be good to make it available in the plugins.json HTTP response as well.
At the moment, that file is a top-level array. Introducing that new field would require making it a top-level object instead. This would be a breaking change of the plugins.json syntax (see this) which would require updating every consumer.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with docs/versioning.md and the current plugins.json response format, then review the linked versioning guidance and its list of consumers. Define the top-level object and version field, and update every consumer affected by the breaking syntax change; done means the response and documented deployments consistently use the new format.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100