Bug: Only showing one server's headers

[zippocage]

In our spectaql config.yml file, we have two servers (test and staging) that differ by URL. They also require different Authorization bearer token.

Issue

Only headers for the first server is shown in the generated documentation (while both server URLs are listed). Is this intended or is this a bug?

Details

If I have the following in the server section of the config.yml:

servers:

  - url: https://staging.example.org/api/
    description: Staging
    headers:
      - name: Authorization
        example: Bearer <STAGING_TOKEN>
        comment: This token must be provided to access the staging backend and API

  - url: https://test.example.org/api/
    description: Test
    headers:
      - name: Authorization
        example: Bearer <TEST_TOKEN>
        comment: This token must be provided to access the test backend and API

Then the generated documentation will render it like this:

[zippocage]

Any updates? @newhouse ?

[newhouse]

This is likely just some legacy carryover from when this project was forked from DociQL.

The obvious change would be to have 2 outputs in the HEADERS area (like there is in the API ENDPOINTS area). But perhaps it would be better to combine those 2 areas and output the Endpoints and Headers together?

@zippocage any suggestions on how you'd expect the output?

[zippocage]

@newhouse I think it makes sense to group each endpoint with its set of headers.

For those deployments where headers are the same independent of endpoint, they may find it a bit repetitive but given the way headers are colocated in the spectaql config file, there is not much to do about that.