Stevan/onspring-api-docs
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix: set min-width on page container

Browse Source
This commit is contained in:
Stevan Freeborn
2023-04-09 23:52:36 -05:00
parent 5c411b4b9a
commit 7f0fa411b0
7 changed files with 18 additions and 10 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/docs/version_002/authentication/copy.md
+2 -6
View File
@@ -1,9 +1,5 @@
# Authentication
The Onpsring API uses API keys to authenticate requests. You can view and manage your API keys your instance.
The Onpsring API uses API keys to authenticate requests. You can view and manage your API keys from within your instance.
The API key needs to be provided in every request. This is done by adding the `X-ApiKey` header to the request.
API Keys are specific to an instance. If you are using the API to access data from multiple instances, you will need to create an API key for each instance. The API key must be in an `Enabled` status and it must be assigned a role that will control the permissions for requests made by the API key. The role assigned should be in an `Active` status.
If the role assigned to the API key does not have sufficient permissions to perform the requested action, an error will be returned. Onspring administrators may configure roles for API keys just as they would any other role in Onspring. However each API key can have only one assigned role.
The API key needs to be provided in every request. This is done by adding the `X-ApiKey` header to the request. The API key must be in an `Enabled` status and it must be assigned a role that will control the permissions for requests made by the API key. The role assigned should be in an `Active` status. If the role assigned to the API key does not have sufficient permissions to perform the requested action, an error will be returned. Onspring administrators may configure roles for API keys just as they would any other role in Onspring. However each API key can have only one assigned role.
src/docs/version_002/authentication/example.md
+2
View File
@@ -1,5 +1,7 @@
# X-ApiKey Header
API Keys are specific to an instance. If you are using the API to access data from multiple instances, you will need to create an API key for each instance.
{% code heading="X-API KEY" language="text" %}
```text
src/docs/version_002/introduction/copy.md
+1 -1
View File
@@ -1,4 +1,4 @@
# Introduction
# Introduction {% .articleTitle %}
The Onspring API is organized around REST. It enables external programs to retrieve, save, and delete data within your Onspring instance. The Onspring API implements version 3 of the Open API Specification (OAS).