Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add new OCS API documentation #10006

Merged
merged 1 commit into from
Jun 8, 2023
+41 −4
Merged

Add new OCS API documentation #10006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,11 @@ _build
developer_manual/html_css_design/img
developer_manual/html_css_design/icons.txt

# OpenAPI file
developer_manual/_static/openapi.json
developer_manual/_static/stoplight-elements.js
developer_manual/_static/stoplight-elements.css

# Exclude Eclipse project
.project

Expand All @@ -47,4 +52,4 @@ venv
.history/

# JetBrains IDEs
.idea/
.idea/
3 changes: 3 additions & 0 deletions .gitmodules
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[submodule "build/openapi-extractor"]
provokateurin marked this conversation as resolved.
Show resolved Hide resolved
path = build/openapi-extractor
url = https://github.com/nextcloud/openapi-extractor
18 changes: 16 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ user-manual-html:
cd user_manual && make html
@echo "User manual build finished; HTML is updated"

developer-manual-html: icons-docs
developer-manual-html: openapi-spec icons-docs
rm -rf developer_manual/_build/html/com
cd developer_manual && make html
@echo "Developer manual build finished; HTML is updated"
Expand All @@ -26,8 +26,22 @@ user-manual-pdf:
cd user_manual && make latexpdf
@echo "User manual build finished; PDF is updated"

icons-docs: clean-icons-docs
get-server-sources:
cd build && sh get-server-sources.sh $(DRONE_BRANCH)

openapi-spec: get-server-sources
git submodule update --init
cd build/openapi-extractor && composer install
provokateurin marked this conversation as resolved.
Show resolved Hide resolved
provokateurin marked this conversation as resolved.
Show resolved Hide resolved
cd build && ./openapi-extractor/merge-specs \
--core server/core/openapi.json \
--merged ../developer_manual/_static/openapi.json \
$$(ls server/apps/*/openapi.json)
cd developer_manual/_static && \
wget https://unpkg.com/@stoplight/[email protected]/web-components.min.js -O stoplight-elements.js && \
wget https://unpkg.com/@stoplight/[email protected]/styles.min.css -O stoplight-elements.css


icons-docs: clean-icons-docs get-server-sources
cd build && composer install && composer update
cd build && php generateIconsDoc.php

Expand Down
1 change: 1 addition & 0 deletions build/openapi-extractor
Open in desktop
Submodule openapi-extractor added at 13d22c
10 changes: 10 additions & 0 deletions developer_manual/_static/openapi.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
<html>
<head>
<title>OCS API</title>
<script src="stoplight-elements.js"></script>
<link rel="stylesheet" href="stoplight-elements.css">
</head>
<body>
<elements-api apiDescriptionUrl="openapi.json" router="hash" hideTryIt="true" logo="logo-blue.png"></elements-api>
</body>
</html>
4 changes: 4 additions & 0 deletions developer_manual/client_apis/OCS/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@
OCS API
===============================

To browse the new OCS API documentation please go `here <../../_static/openapi.html>`_.

The old documentation is still kept as it provides some additional documentation that is not completely covered in the new documentation:

.. toctree::

ocs-api-overview
Expand Down
2 changes: 1 addition & 1 deletion developer_manual/conf.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ['../_shared_assets/static']
html_static_path = ['../_shared_assets/static', '_static']

# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
# using the given strftime format.
Expand Down