https://github.com/livingdocsio/openapi
OpenAPI (Swagger) spec for Livingdocs Public API
https://github.com/livingdocsio/openapi
openapi openapi-specification openapi3
Last synced: 6 months ago
JSON representation
OpenAPI (Swagger) spec for Livingdocs Public API
- Host: GitHub
- URL: https://github.com/livingdocsio/openapi
- Owner: livingdocsIO
- Created: 2022-09-16T08:16:19.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-01-18T16:02:44.000Z (about 2 years ago)
- Last Synced: 2024-04-14T11:56:02.877Z (almost 2 years ago)
- Topics: openapi, openapi-specification, openapi3
- Homepage:
- Size: 337 KB
- Stars: 0
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Livingdocs OpenAPI Specification
OpenAPI 3 specification for Livingdocs Public API
This file makes it easy to test and share our API enpoints.
It's available [here](/livingdocs-openapi.json)
## Supported environments
- localhost
- Livingdocs demo at edit.livingdocs.io, deprecated from release-2023-09
## How to use it
The OpenAPI spec is hosted by Github pages at:
[https://livingdocsio.github.io/openapi/livingdocs-openapi.json](https://livingdocsio.github.io/openapi/livingdocs-openapi.json)
This can be imported in Insomnia or Postman to have a full collections of API enpoints to test.
Alternatively the same can be done with online tools. You just need to paste the OpenAPI spec url in one of the following tools.
[Swagger UI](https://petstore.swagger.io/)
[Swagger Editor](https://editor.swagger.io/)
### Some other tools
[OpenAPI Tools](https://openapi.tools/) list of useful tools related to OpenAPI
[ApiTree](https://www.apitree.com/) hosted API documentation based on OpenAPI
[OpenDocumenter](https://ouropencode.github.io/OpenDocumenter/):
for creating a documentation from OpenAPI spec
## How to develop
Import the livingdocs-openapi.json file into insomnia as a design document, here you can test the APIs and add new endpoints.
For authenticated requests you need an API token from your Livingdocs project.
Alternatively you can do everything in VS Code using the [OpenAPI (Swagger) Extension](https://marketplace.visualstudio.com/items?itemName=42Crunch.vscode-openapi).
### Example endpoint
```yaml
/channels/{channelHandle}:
get:
security:
- bearerAuth: [public-api:read]
parameters:
- name: channelHandle
in: path
description: Optional channelHandle. Will return first channel of a project if none is passed.
required: true
schema:
type: string
example: ""
tags:
- Project
summary: details and configuration of this project.
operationId: getChannel
responses:
"200":
description: ok
```
## How to contribute
Keep the same structure as our documentation [docs](https://docs.livingdocs.io/reference-docs/public-api/).
Many API endpoints are still missing. Please mark the category as completed when all its endpoints are registered in the spec.
- Project ✅
- Composition API ✅
- Publications ✅
- Search ✅
- Document Lists ✅
- Document Categories ✅
- Media Library ✅
- Imports ✅
- Sitemaps ✅
- Menus ✅
- Routing ✅
- Add Delivery Status ✅
- Health ✅
## TODOs and future ideas
- add all the Public API endpoints from our docs ✅
- make available the OAS publicly ✅
- embedd the Swagger UI in our docs
- support to extend downstream with downstream declaration
- generate the spec by the server