Header information #83
Conversation
endpoints.html
Outdated
| <th>Description</th> | ||
| </thead> | ||
| <tbody> | ||
|
|
_data/api-swagger.yaml
Outdated
| required: true | ||
| ApiKeyParam: | ||
| value: | | ||
| `APPKey {Appkey}` |
endpoints.html
Outdated
| @@ -9,6 +9,27 @@ | |||
| <p>All input strings should be UTF-8 encoded, our response is always UTF-8 encoded.</p> | |||
| <p>Some of our endpoints return both the status of the transaction and signer activities. Further details about the statuses and activities can be found <a href="/status-activity/">here</a>.</p> | |||
|
|
|||
| <h3>Default Headers</h3> | |||
| <p>In order to communicate with Signhost, the API is expecting the following http headers for all requests. The parts between curlybraces indicate values that need to be replaced.</p> | |||
There was a problem hiding this comment.
This would result in saying we require the json version header in every request. But not all requests return JSON, so I don't think this is correct
_data/api-swagger.yaml
Outdated
| parameters: | ||
| AppkeyParam: | ||
| headers: | ||
| AppKey: |
There was a problem hiding this comment.
Is this new in swagger? Or did you break swagger compatability?
WouterJanson
force-pushed
the
HeaderInformation
branch
from
cea66f0
to
691e90e
Compare
|
Updated:
|
WouterJanson
force-pushed
the
HeaderInformation
branch
2 times, most recently
from
16cf4b2
to
ab2c5a0
Compare
| in: header | ||
| type: string | ||
| required: true | ||
| ApiKeyParam: | ||
| default: application/vnd.signhost.v1+json |
There was a problem hiding this comment.
I think default might be confusing, because:
- it MUST be explicitly to use new features like the authentication array
- this is only valid for JSON
Let's leave this open and see @MrJoe 's thoughts on this
There was a problem hiding this comment.
- this is only valid for JSON
Yes, that's why this parameter is only added to specific endpoints in the swagger file, so in that case default would make sense and it's also the way to add a value according to the spec. (Which I broke in the previous version of this PR 😅)
However I do agree that it might be confusing phrased in the documentation page itself.
_includes/httpheaders.html
Outdated
| {% endfor %} | ||
| </tbody> | ||
| </table> | ||
| <!-- End list of all HTTP headers --> |
WouterJanson
force-pushed
the
HeaderInformation
branch
from
ab2c5a0
to
669fcce
Compare
application/vnd.signhost.v1+jsonAccept header to the curl examples.See #82