Skip to content

Write documentation on new API endpoints #1186

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

Merged
christianlupus merged 3 commits into from
Aug 31, 2022
Merged

Write documentation on new API endpoints #1186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76eeed4
Create API documentation to close security issue
christianlupus Aug 31, 2022
27d6601
Update documentation for devs
christianlupus Aug 31, 2022
e094e41
Update changelog
christianlupus Aug 31, 2022
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
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
## [Unreleased]

### Documentation
- Defining new API interface to fix security issue
[#1186](https://github.com/nextcloud/cookbook/pull/1186) @christianlupus


## 0.9.14 - 2022-08-29
Expand Down
60 changes: 60 additions & 0 deletions docs/dev/api/0.1.0/index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
<!-- HTML for static distribution bundle build -->
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Public API cookbook app</title>
<link rel="stylesheet" type="text/css" href="../swagger/swagger-ui.css" />
<link rel="icon" type="image/png" href="../swagger/favicon-32x32.png" sizes="32x32" />
<link rel="icon" type="image/png" href="../swagger/favicon-16x16.png" sizes="16x16" />
<style>
html
{
box-sizing: border-box;
overflow: -moz-scrollbars-vertical;
overflow-y: scroll;
}

*,
*:before,
*:after
{
box-sizing: inherit;
}

body
{
margin:0;
background: #fafafa;
}
</style>
</head>

<body>
<div id="swagger-ui"></div>

<script src="../swagger/swagger-ui-bundle.js" charset="UTF-8"> </script>
<script src="../swagger/swagger-ui-standalone-preset.js" charset="UTF-8"> </script>
<script>
window.onload = function() {
// Begin Swagger UI call region
const ui = SwaggerUIBundle({
url: "openapi-cookbook.yaml",
dom_id: '#swagger-ui',
deepLinking: true,
presets: [
SwaggerUIBundle.presets.apis,
SwaggerUIStandalonePreset
],
plugins: [
SwaggerUIBundle.plugins.DownloadUrl
],
layout: "StandaloneLayout"
});
// End Swagger UI call region

window.ui = ui;
};
</script>
</body>
</html>
Loading