Values that are common to all returned results

[ianfore]

@nsheff raised elsewhere

What do you do about the values that are common to all returned results, like the 'namespace' value in the return of a list of SchemaRecords, or the 'schema_name' value in the return of schemas. Do we put them outside of "results"? Just duplicate them across each result object? or not include them at all?

[ianfore]

This has to do with design decisions on whether we are returning complex objects, with some attributes (the common ones) at the higher level and others at lower levels in the nested structure.

I don't think of namespace as a complex object in that way, but I do for schema. As part of this we should consider the following. I raised it in the 'working document', but it's probably better to cover it here:
What is the schema?
See the gks-core schema at https://github.com/ga4gh/gks-core/tree/1.0/schema/gks-core
gks-core-source.yaml is a single ‘schema’ from which eight json schema are generated.
Not all of the eight separate schema might be changed at the same time.
What should be considered as the schema? The single yaml file or the eight individual schema?

It relates to the current issue/thread as follows:
There is a higher level structure (probably referred to as the gks-core schema), and eight json gks-core json schema within that.

[nsheff]

The link leads to a 404, but I would guess the eight json schemas are each an individual schema.

[nsheff]

This is the issue we were trying to raise in #11

[ianfore]

The link leads to a 404, but I would guess the eight json schemas are each an individual schema.

Link fixed.
Yes there are eight individual JSON schema, but overall the schema for gks-core is all of them together, and appears to be versioned at that level. It seems important to look at the practices that workstreams are following.

[sconsult-ma]

Nathan has proposed an array called Results for all list responses
The idea is to move from specific concrete types for each response type to a parameterized response container type with a fixed structure:
NamespacesResponse → PagedResponse
SchemasResponse → PagedResponse
SchemaVersionsResponse → PagedResponse

@jfuerth add to API Spec