Hello, we are evaluating whether JSON:API is a good fit as a specification to use to help provide a more cohesive API collection across a range of existing and new APIs we are building.
We have a need to include top-level links for a collection resource. In this case, it’s to provide a link to let the client know where to go to request elevated permissions so they can get additional access to content that’s been redacted from the current collection they are seeing.
We’d initially misinterpreted the spec assuming that “MAY include” meant that additional top-level links were allowed outside of “self” and pagination links. However, we’ve now realised that we should have interpreted “MAY include” to mean “MAY only include” and that this oversight might affect the ability for client libraries to work with our APIs
What advice or suggestions are floating around to deal with this need? I didn’t find anything obvious in discussion here thus far.
Thanks in advance!