Comments (2)
First of all thanks for bringing this up, we haven't really considered this ourselves before.
Outright removing them is not something we have planned unless miHoYo contacts us and specifically asks us to remove the information about unreleased entities from the repository. We aren't bound by any NDA (as of yet) and it's also not our responsibility to make sure that every contributor to this repository upholds their NDAs with miHoYo, so we will still happily accept any pull requests with information about unreleased entities.
Putting said unreleased entities behind a query parameter or similar, would be something we could explore though. The specifics on how we would implement this would still be up to debate, though I personally would suggest putting a new property on said unreleased entities, i.e. "unreleased": true
or putting them in a separate folder i.e. assets/unreleased-data
. We would also love to hear your feedback on how we could implement this in case you have a better idea as to how we could implement this.
from api.
I think the technical implementation doesn't matter that much. However, since this is an open source project and not all entities are clearly defined through a schema (as far as I know, I just looked at existing ones), it would be most clear to implement this functionality by putting them in a separate folder. This makes it clear for all contributors that unreleased entities should go in a separate folder.
If you make it dependent on a property, you either have to include the property on all entities, also released ones with the value false, or define a schema somewhere that people can refer to when contributing so they know unreleased entities need an extra property 'unreleased'.
I think the important part is how it will affect usage of the API. On that topic I personally think the following requirements should be met:
- An endpoint by default excludes all unreleased entities.
- Each endpoint will support the query parameter 'unreleased'. If true, unreleased entities are included in the response. If false unreleased entities are not included in the response.
The second requirement would break backwards compatibility, so I understand if you think differently.
from api.
Related Issues (20)
- Website out of sync HOT 3
- Add icon-big to thoma HOT 2
- Search via Name HOT 1
- Missing Tighnari Normal Attack
- Inconsistency API response HOT 4
- Add PT language to lang HOT 1
- API DOCS HOT 2
- [Request] homogeneous API response
- [Bug][Refactor] unify keys drops/items HOT 1
- Adding release date attribute to character entity
- Only 57 characters showable HOT 1
- [Invalid] Dendro traveler appears as 4*
- Missing Hunter's Path 5 star weapon
- [Bug] Inconsistent naming for Diluc's burst icon
- Nahida is missing the 'gender' key
- [Bug] Inconsistent Naming with Fontaine Character Icons HOT 3
- Cyno's gender incorrectly marked as female
- Talent Books data uses Incorrect ID for Heizou
- Inconsistency in case types( camelCase and snake_case) in characters api HOT 1
- Emilie data hasn't been added yet
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 api.