Skip to content

Commit

Permalink
fixup! Add information about default headers
Browse files Browse the repository at this point in the history
  • Loading branch information
WouterJanson committed Jan 17, 2020
1 parent 696ba21 commit cea66f0
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 17 deletions.
25 changes: 11 additions & 14 deletions _data/api-swagger.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,22 +10,19 @@ schemes:
- https
produces:
- application/json
headers:
AppKey:
parameters:
AppkeyParam:
name: Application
value: |
`APPKey {Appkey}`
description: The appkey that is generated at signup.
ApiKey:
description: The APPKey
in: header
type: string
required: true
ApiKeyParam:
name: Authorization
value: |
`APIKey {Usertoken}`
description: Your usertoken, can be generated in the Signhost portal.
Accept:
name: Accept
value: |
`application/vnd.signhost.v1+json`
description: The Signhost Api client version number.
description: The usertoken
in: header
type: string
required: true

paths:
'/api/transaction/{transactionId}':
Expand Down
15 changes: 15 additions & 0 deletions _data/headers.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
AppKey:
name: Application
value: |
`APPKey {AppKey}`
description: The appkey that is generated at signup.
ApiKey:
name: Authorization
value: |
`APIKey {Usertoken}`
description: Your usertoken, can be generated in the Signhost portal.
Accept:
name: Accept
value: |
`application/vnd.signhost.v1+json`
description: The Signhost Api client version number.*
6 changes: 3 additions & 3 deletions endpoints.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<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>
<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>
<table>
<thead>
<tr>
Expand All @@ -19,8 +19,7 @@ <h3>Default Headers</h3>
<th>Description</th>
</thead>
<tbody>

{% for headers in site.data.api-swagger.headers %}
{% for headers in site.data.headers %}
<tr>
<td>{{ headers[1].name }}</td>
<td>{{ headers[1].value | markdownify }}</td>
Expand All @@ -29,6 +28,7 @@ <h3>Default Headers</h3>
{% endfor %}
</tbody>
</table>
<p>* The Accept header is not required for requests to endpoints that return something other than JSON.</p>

<!-- Begin list of all endpoints-->
<h3>All endpoints:</h3>
Expand Down

0 comments on commit cea66f0

Please sign in to comment.