Show Corteza: Hosted REST API Documentation

đź’» Core Engineering
#1

The REST API documentation relies on dynamic rendering of YAML files.

In order to access the API you need to run a documentation server or have an instance of Corteza running.

I took the liberty of uploading the REST documentation source files in cloudflare pages so anyone can access them. This requires manual maintainece, so if something needs to be updated, please let me know.

Otherwise, please enjoy https://corteza-rest-api-docs.pages.dev/

2 Likes
#2

Thank you – good point. We had a task re. this a while ago but I think we dismissed it with “if you need the docs you have your server running anyway”.

Should be part of docs.cortezaproject.org. Will adjust our build pipelines to include it.

1 Like
#3

Did this ever happen?

#4

Hi,

there was news of this “somewhere”, not sure where anymore :slight_smile:

image
image709Ă—552 23.2 KB

https://docs.cortezaproject.org/corteza-api-docs/corteza-server/2023.3/index.html

2 Likes
#5

Thanks! Good to know.

1 Like