Code Monkey home page Code Monkey logo

Comments (5)

vthornheart-bng avatar vthornheart-bng commented on September 1, 2024

Hmm, it looks like reference objects are the only ones that can't do it, but I'll give it a look: in the example that you give, it's not terribly helpful having that metadata there. It'd be more helpful in the class that refers to DictionaryComponentResponseOfint64AndDestinyCharacterComponent.

If we do end up with locations where this extra metadata is genuinely useful but it's attached to a reference, I would defer to the remainder of that sentence " and any properties added SHALL be ignored." I'm fine with it if standard parsers ignore it, as long as it's there for custom parsers that understand the contextual meaning of x-destiny-component-type-dependency and other extension properties. If it breaks standard parsers, that's something else... but if they're obeying the "SHALL be ignored" part, then I won't lose sleep over breaking with their standard in a way that they ignore.

from api.

lowlines avatar lowlines commented on September 1, 2024

Having these also made it a lot easier to add Bungie API specific metadata to the wiki builder. Otherwise I'd probably have to do a bit more regex to pull this information from component urls or other places (which as we found out with the generics stuff, caused some issues for custom parsers).

from api.

vthornheart-bng avatar vthornheart-bng commented on September 1, 2024

A question before I go about changing this - is it actually causing failure in any existing parsers? According to the spec, it's being ignored... I'd actually rather leave it if it's useful to people and not causing parser tools to fail.

from api.

vpzed avatar vpzed commented on September 1, 2024

As I mentioned in another issue there isn't an official "the law" json schema for v3. In the meantime the Google Gnostic team has made this one which is what some preliminary parsers are using (and how I found this item).

The json schema definition there has this which shows additionalProperties: false - but again it isn't official so I'd say it is your call until the official json schema is released for v3. It could go either way with the current wording.

"reference": {
  "type": "object",
  "description": "A simple object to allow referencing other components in the specification, internally and externally.  The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules.   For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification.",
  "required": [
    "$ref"
  ],
  "additionalProperties": false,
  "properties": {
    "$ref": {
      "type": "string"
    }
  }
},

from api.

vthornheart-bng avatar vthornheart-bng commented on September 1, 2024

Hmm - let's table it for now then until we get the official ones. It's so convenient, I'm going to keep my fingers crossed. :)

from api.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo 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.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.