Skip to content

Commit 0fa504c

Browse files
update
1 parent 3968265 commit 0fa504c

File tree

7 files changed

+91
-71
lines changed

7 files changed

+91
-71
lines changed

.editorconfig

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# https://editorconfig.org
2+
3+
# top-most EditorConfig file
4+
root = true
5+
6+
[*]
7+
charset = utf-8
8+
indent_style = space
9+
indent_size = 4
10+
end_of_line = lf
11+
trim_trailing_whitespace = true
12+
insert_final_newline = true
13+
14+
[*.md]
15+
indent_size = 2
16+
17+
[*.yml]
18+
indent_size = 2

.gitignore

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
2+
13
# phpstorm project files
24
.idea
35

@@ -9,10 +11,10 @@ nbproject
911
.project
1012
.settings
1113

12-
# windows thumbnail cache
14+
# Windows thumbnail cache
1315
Thumbs.db
1416

15-
# Mac DS_Store Files
17+
# MacOS DS_Store Files
1618
.DS_Store
1719

1820
CNAME

CODE_OF_CONDUCT.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Our Pledge
44

5-
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
5+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.
66

77
We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
88

@@ -18,14 +18,11 @@ Examples of behavior that contributes to a positive environment for our communit
1818

1919
Examples of unacceptable behavior include:
2020

21-
* The use of sexualized language or imagery, and sexual attention or
22-
advances of any kind
21+
* The use of sexualized language or imagery, and sexual attention or advances of any kind
2322
* Trolling, insulting or derogatory comments, and personal or political attacks
2423
* Public or private harassment
25-
* Publishing others' private information, such as a physical or email
26-
address, without their explicit permission
27-
* Other conduct which could reasonably be considered inappropriate in a
28-
professional setting
24+
* Publishing others' private information, such as a physical or email address, without their explicit permission
25+
* Other conduct which could reasonably be considered inappropriate in a professional setting
2926

3027
## Enforcement Responsibilities
3128

@@ -67,18 +64,20 @@ Community leaders will follow these Community Impact Guidelines in determining t
6764

6865
### 4. Permanent Ban
6966

70-
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
67+
**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior, harassment of an individual, or aggression toward or disparagement of classes of individuals.
7168

72-
**Consequence**: A permanent ban from any sort of public interaction within the project community.
69+
**Consequence**: A permanent ban from any sort of public interaction within the community.
7370

7471
## Attribution
7572

76-
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
77-
available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
73+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.1, available at [https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
7874

79-
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
75+
Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder][Mozilla CoC].
8076

81-
[homepage]: https://www.contributor-covenant.org
77+
For answers to common questions about this code of conduct, see the FAQ at [https://www.contributor-covenant.org/faq][FAQ]. Translations are available at [https://www.contributor-covenant.org/translations][translations].
8278

83-
For answers to common questions about this code of conduct, see the FAQ at
84-
https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.
79+
[homepage]: https://www.contributor-covenant.org
80+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
81+
[Mozilla CoC]: https://github.com/mozilla/diversity
82+
[FAQ]: https://www.contributor-covenant.org/faq
83+
[translations]: https://www.contributor-covenant.org/translations

LICENSE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2021 OpenSourceWebsite
3+
Copyright (c) OpenSourceWebsite.org
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
66

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<h1 align="center">OpenSourceWebsite API Documentation</h1>
22

3-
Live: https://apidocs.opensourcewebsite.org
3+
Live: [apidocs.opensourcewebsite.org](https://apidocs.opensourcewebsite.org)
44

5-
Specification: https://apidocs.opensourcewebsite.org/openapi.yaml
5+
Specification: [openapi.yaml](https://apidocs.opensourcewebsite.org/openapi.yaml)
66

77
The repository is a part of the [OpenSourceWebsite Organization](https://github.com/opensourcewebsite-org). This project and everyone participating in it is governed by the [Code of Conduct](CODE_OF_CONDUCT.md).
88

@@ -24,7 +24,9 @@ https://github.com/mrdoob/three.js/wiki/How-to-run-things-locally
2424

2525
## Feedback
2626

27-
Join our [Slack](https://join.slack.com/t/opensourcewebsite/shared_invite/enQtNDE0MDc2OTcxMDExLWJmMjFjOGUxNjFiZTg2OTc0ZDdkNTdhNDIzZDE2ODJiMGMzY2M5Yjg3NzEyNGMxNjIwZWE0YTFhNTE3MjhiYjY), [Discord](https://discord.gg/94WpSPJ), [Gitter](https://gitter.im/opensourcewebsite-org) or [email support](mailto:hello@opensourcewebsite.org).
27+
To request a new feature, submit a bug report, give us feedback, start a design discussion or have an idea to make this code better feel free to [open an issue](https://github.com/opensourcewebsite-org/apidocs-opensourcewebsite-org/issues), or [create a pull request](https://github.com/opensourcewebsite-org/apidocs-opensourcewebsite-org/pulls).
28+
29+
Please send all security issues to [security@opensourcewebsite.org](mailto:security@opensourcewebsite.org).
2830

2931
## License
3032

index.html

Lines changed: 48 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -1,55 +1,54 @@
11
<!-- HTML for static distribution bundle build -->
2-
<!DOCTYPE html>
3-
<html lang="en">
4-
<head>
5-
<meta charset="UTF-8">
6-
<title>OpenSourceWebsite API Documentation</title>
7-
<!--" https://cdnjs.com/libraries/swagger-ui -->
8-
<!-- https://www.jsdelivr.com/package/npm/swagger-ui -->
9-
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.47.1/swagger-ui.css" >
10-
<style>
11-
html
12-
{
13-
box-sizing: border-box;
14-
overflow: -moz-scrollbars-vertical;
15-
overflow-y: scroll;
16-
}
2+
<!DOCTYPE html>
3+
<html lang="en">
174

18-
*,
19-
*:before,
20-
*:after
21-
{
22-
box-sizing: inherit;
23-
}
5+
<head>
6+
<meta charset="UTF-8">
7+
<title>OpenSourceWebsite API Documentation</title>
8+
<!--" https://cdnjs.com/libraries/swagger-ui -->
9+
<!-- https://www.jsdelivr.com/package/npm/swagger-ui -->
10+
<link rel="stylesheet" type="text/css" href="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/5.17.14/swagger-ui.css">
11+
<style>
12+
html {
13+
box-sizing: border-box;
14+
overflow: -moz-scrollbars-vertical;
15+
overflow-y: scroll;
16+
}
2417

25-
body
26-
{
27-
margin:0;
28-
background: #fafafa;
29-
}
30-
</style>
31-
</head>
18+
*,
19+
*:before,
20+
*:after {
21+
box-sizing: inherit;
22+
}
3223

33-
<body>
34-
<div id="swagger-ui"></div>
24+
body {
25+
margin: 0;
26+
background: #fafafa;
27+
}
28+
</style>
29+
</head>
3530

36-
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.47.1/swagger-ui-bundle.js"> </script>
37-
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.47.1/swagger-ui-standalone-preset.js"> </script>
38-
<script>
39-
window.onload = function() {
40-
// Begin Swagger UI call region
41-
const ui = SwaggerUIBundle({
42-
url: "./openapi.yaml",
43-
dom_id: '#swagger-ui',
44-
deepLinking: true,
45-
presets: [
46-
SwaggerUIBundle.presets.apis,
47-
],
48-
})
49-
// End Swagger UI call region
31+
<body>
32+
<div id="swagger-ui"></div>
5033

51-
window.ui = ui
52-
}
53-
</script>
54-
</body>
55-
</html>
34+
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/5.17.14/swagger-ui-bundle.js"> </script>
35+
<script src="https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/5.17.14/swagger-ui-standalone-preset.js"> </script>
36+
<script>
37+
window.onload = function () {
38+
// Begin Swagger UI call region
39+
const ui = SwaggerUIBundle({
40+
url: "./openapi.yaml",
41+
dom_id: '#swagger-ui',
42+
deepLinking: true,
43+
presets: [
44+
SwaggerUIBundle.presets.apis,
45+
],
46+
})
47+
// End Swagger UI call region
48+
49+
window.ui = ui
50+
}
51+
</script>
52+
</body>
53+
54+
</html>

openapi.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
openapi: 3.0.0
1+
openapi: 3.1.0
22
info:
33
title: OpenSourceWebsite API Documentation
44
description: OpenSourceWebsite API Documentation

0 commit comments

Comments
 (0)