Skip to content

Commit ee5de1f

Browse files
hasheddanszczys
authored andcommitted
feat: add OpenAPI v3 link to docs
Updates docs to include OpenAPI v3 links. Signed-off-by: Daniel Mangum <[email protected]>
1 parent e874c1e commit ee5de1f

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

docs/reference/3-rest-api/1-overview.mdx

+16-5
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,29 @@ title: Golioth REST API
66
import useDocusaurusContext from "@docusaurus/useDocusaurusContext";
77
export const SwaggerUrl = () => {
88
const swaggerUrl = process.env.SWAGGER_URL;
9-
return <a href={swaggerUrl}>{swaggerUrl}</a>;
9+
return <a href={swaggerUrl}>Swagger / OpenAPI v2</a>;
1010
};
1111

12-
You can use Golioth API for access all services available on the platform, like device management, provisioning, data resources and others services to be build in the future.
12+
export const OpenAPIUrl = () => {
13+
const openAPIUrl = process.env.OPENAPI_URL;
14+
return <a href={openAPIUrl}>OpenAPI v3</a>;
15+
};
16+
17+
You can use Golioth API for access all services available on the platform, like
18+
device management, provisioning, data resources and others services to be build
19+
in the future.
1320

1421
#### API Usage
1522

16-
Our API is documented using OpenAPI definitions. You can access the [API Reference Page](/reference/rest-api/openapi) to check all endpoints and methods that can be used. A important aspect is authentication, that can be check on the [Authentication Guide](/reference/rest-api/auth).
23+
Our API is documented using OpenAPI definitions. You can access the [API
24+
Reference Page](/reference/rest-api/openapi) to check all endpoints and methods
25+
that can be used. For more information on authentication check the
26+
[Authentication Guide](/reference/rest-api/auth).
1727

18-
#### Importing OpenAPI/Swagger definitions
28+
#### Importing OpenAPI/Swagger Definitions
1929

20-
You can test Golioth API using a Graphical User Interface (GUI) like Postman or Insomnia. Here are some links on how to import Open API definitions using those projects. For the Swagger file URL, you can use <SwaggerUrl/> url to import our API definitions.
30+
You can test the Golioth API using a Graphical User Interface (GUI) like Postman
31+
or Insomnia. Both <OpenAPIUrl/> and <SwaggerUrl/> definitions are available.
2132

2233
- https://learning.postman.com/docs/integrations/available-integrations/working-with-openAPI/
2334
- https://support.insomnia.rest/article/172-importing-and-exporting-data

0 commit comments

Comments
 (0)