Skip to content

Commit

Permalink
Create Documentation for Enterprise Rest API [DEX-78] (#1097)
Browse files Browse the repository at this point in the history
* create documentation for enterprise rest api

* review fixes

* review fixes

* review fixes

* review fixes

* review fixes

* DOCS-752: add swagger script and collector support

Includes changes to playbook and additional files needed to display swagger content

* DOCS-752: update nav and tidy page names

* DOCS-752: update nav and legacy API refs

* DOCS-752: update edition refs and deprecation

* DOCS-752: switch names to text rather than variables

* DOCS-752: more name changes and move note

---------

Co-authored-by: Oliver Howell <[email protected]>
  • Loading branch information
celenmelike and oliverhowell authored May 17, 2024
1 parent 46fa9dd commit 246b989
Show file tree
Hide file tree
Showing 12 changed files with 518 additions and 8 deletions.
6 changes: 5 additions & 1 deletion antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ content:
- url: .
branches: HEAD
start_path: docs
- url: https://github.com/hazelcast/hazelcast-mono
branches: [master]
start_path: docs/rest
ui:
bundle:
url: https://github.com/hazelcast/hazelcast-docs-ui/releases/latest/download/ui-bundle.zip #../hazelcast-docs-ui/build/ui-bundle.zip
Expand All @@ -32,4 +35,5 @@ asciidoc:
ucd: User Code Deployment
extensions:
- ./docs-tabs-library/tabs-block.js
- asciidoctor-kroki
- asciidoctor-kroki
- ./lib/swagger-ui-block-macro.js
4 changes: 2 additions & 2 deletions docs/modules/clients/partials/rest-deprecation.adoc
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[CAUTION]
.Deprecation Notice for the REST API
.Deprecation Notice for the Community Edition REST API
====
The REST API has been deprecated and will be removed as of Hazelcast version 7.0. An improved version of this feature is under development.
The Community Edition REST API has been deprecated and will be removed as of Hazelcast version 7.0. An improved version of this feature is under development. For more info, see xref:maintain-cluster:enterprise-rest-api.adoc[REST API]
====
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 246b989

Please sign in to comment.