Not sure how interesting this might be, or whether 'Support" is even the right category for the post, but I saw an older post on API access, and I figured I'd add to the API lore by describing how to use https://editor-next.swagger.io/ to make a quick and dirty wrapper for playing with Stardog's REST API.
Pre-conditions:
These instructions presume that you have set up an endpoint that uses "Basic Auth". I assume that there are instructions on how to do this elsewhere. If here aren't I'd be happy to write that up separately.
In any case, here are the properties for the Basic Auth endpoint that I created:
The significance of creating this endpoint is that has:
- The server url:
https://sd-6276c8eb.stardog.cloud:5820 - The name of a user:
api_access
And, because SSO was switched off when the endpoint was created, we know that this api_access user will use Basic auth to make API calls.
Note that a password (not shown) was provided when the endpoint was created
Setting up wrapper:
- Download the Stardog Open API metadata:
https://stardog-union.github.io/http-docs/openapi.json - Open
https://editor-next.swagger.io/ - Drag the downloaded
openapi.jsonfile to the left pane of the Swagger Editor UI - Either
- replace "url": "http://localhost:5820" (around line 23) with your endpoint url (in my case
https://sd-6276c8eb.stardog.cloud:5820) - or add your endpoint as a server, in which case your servers section will look something like:
- replace "url": "http://localhost:5820" (around line 23) with your endpoint url (in my case
"servers": [
{
"url": "http://localhost:5820"
},
{
"url": "https://sd-6276c8eb.stardog.cloud:5820"
}
],
- Add a
securitySchemesdeclaration to your components section (around line 7760) and add abasicAuthscheme tosecuritySchemes. The first seven lines of JSON in your components section should now look something like:
"components": {
"securitySchemes": {
"basicAuth": {
"type": "http",
"scheme": "basic"
}
},
- Add a
securitysection at the end of the JSON metadata. It can actually go anywhere .. it just needs to be a "top-level" item, that is a peer of the components section .. but I elected to put it as the last section of the metadata .. so the last five lines of my modified metadata look like:
,
security:[
{basicAuth: []}
]
}
Seeing effect of changes:
If you made all of the edits correctly:
- you should now be able to select your SD Cloud endpoint,
- and you should be able to open a dialog that allows you to add your user credentials:
- and every endpoint should now be configured to pass "Basic Auth" info in the HTTP request headers
Testing your Handiwork:
Assuming:
- the configured user has the proper rights configured,
- and you have the correct server selected
- and you have entered credentials for the API user ..
.. you should be able to make a call, just to see if things work properly.
I chose to use the GET /admin/status endpoint, because it doesn't require any parameters, it's close to the top of the page, and, since it's a GET, there is no risk of unwanted mutation of content.
