Skip to content

Commit c7b852d

Browse files
authored
Add repo files (#490)
1 parent 1de1c39 commit c7b852d

5 files changed

+240
-14
lines changed

AUTHORS.md

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
# This is the list of OpenAPI Common significant contributors.
2+
#
3+
# This file does not necessarily list everyone who has contributed code,
4+
# especially since many employees of one corporation may be contributing.
5+
# To see the full list of contributors, see the revision history in
6+
# source control.
7+
#
8+
# For contributions made under a Corporate CLA, then the copyright
9+
# belongs to that organization.
10+
#
11+
# If a contribution was made under an Individual CLA, the submitter
12+
# has indicated that they own the copyright. If that is your case, and
13+
# you want to be added to this file, please submit a request.
14+
#
15+
#
16+
ANSYS, Inc.

CHANGELOG.md

+149
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,149 @@
1+
# Changelog
2+
3+
## openapi-common 1.4.0, 2024-01-10
4+
5+
### New features
6+
7+
* [Pull request #451](https://github.com/ansys/openapi-common/pull/451):
8+
Move some auto-generated model methods to the base class.
9+
10+
### Bugs fixed
11+
12+
* [Issue #443](https://github.com/ansys/openapi-common/issues/443),
13+
[Pull request #447](https://github.com/ansys/openapi-common/pull/447):
14+
`Enum` deserialization now properly instantiates the `Enum`.
15+
16+
### Documentation
17+
18+
* [Pull request #457](https://github.com/ansys/openapi-common/pull/457):
19+
Fix Ubuntu 20.04 installation instructions.
20+
21+
### Contributors
22+
23+
* Doug Addy (Ansys)
24+
* Andy Grigg (Ansys)
25+
* Ludovic Steinbach (Ansys)
26+
27+
## openapi-common 1.3.0, 2023-11-13
28+
29+
### New features
30+
31+
* [Issue #311](https://github.com/ansys/openapi-common/issues/311),
32+
[Pull request #312](https://github.com/ansys/openapi-common/pull/312):
33+
Support response type to status code mapping for response deserialization.
34+
35+
### Bugs fixed
36+
37+
* [Issue #313](https://github.com/ansys/openapi-common/issues/313),
38+
[Pull request #316](https://github.com/ansys/openapi-common/pull/316):
39+
Improve `ApiConnectionException` error message.
40+
* [Issue #380](https://github.com/ansys/openapi-common/issues/380),
41+
[Pull request #381](https://github.com/ansys/openapi-common/pull/381):
42+
Improve regular expression performance while deserializing response.
43+
44+
### Miscellaneous
45+
46+
* [Pull request #347](https://github.com/ansys/openapi-common/pull/347):
47+
Drop support for Python 3.7.
48+
* [Pull request #432](https://github.com/ansys/openapi-common/pull/432):
49+
Drop support for Python 3.8.
50+
51+
### Contributors
52+
53+
* Doug Addy (Ansys)
54+
* Andy Grigg (Ansys)
55+
* Ludovic Steinbach (Ansys)
56+
57+
## openapi-common 1.2.2, 2023-04-14
58+
59+
### Bugs fixed
60+
61+
* [Issue #380](https://github.com/ansys/openapi-common/issues/380),
62+
[Pull request #381](https://github.com/ansys/openapi-common/pull/381):
63+
Improve regular expression performance while deserializing response.
64+
65+
### Contributors
66+
67+
* Doug Addy (Ansys)
68+
69+
## openapi-common 1.2.1, 2023-02-20
70+
71+
### New features
72+
73+
* [Issue #311](https://github.com/ansys/openapi-common/issues/311),
74+
[Pull request #312](https://github.com/ansys/openapi-common/pull/312):
75+
Support response type to status code mapping for response deserialization.
76+
77+
### Bugs fixed
78+
79+
* [Issue #313](https://github.com/ansys/openapi-common/issues/313),
80+
[Pull request #316](https://github.com/ansys/openapi-common/pull/316):
81+
Improve `ApiConnectionException` error message.
82+
83+
### Contributors
84+
85+
* Andy Grigg (Ansys)
86+
* Ludovic Steinbach (Ansys)
87+
88+
## openapi-common 1.2.0, 2023-01-03
89+
90+
### New features
91+
92+
* [Issue #220](https://github.com/ansys/openapi-common/issues/220),
93+
[Pull request #221](https://github.com/ansys/openapi-common/pull/221):
94+
Handle `Enum` objects as properties of models.
95+
* [Issue #129](https://github.com/ansys/openapi-common/issues/129),
96+
[Pull request #139](https://github.com/ansys/openapi-common/pull/139):
97+
Replace `requests-oauthlib` with `requests-auth`.
98+
99+
### Bugs fixed
100+
101+
* [Issue #284](https://github.com/ansys/openapi-common/issues/284),
102+
[Pull request #288](https://github.com/ansys/openapi-common/pull/288):
103+
Fix formatting path with multiple path parameters.
104+
105+
### Contributors
106+
107+
* Doug Addy (Ansys)
108+
* Andy Grigg (Ansys)
109+
* Ludovic Steinbach (Ansys)
110+
* Kathy Pippert (Ansys)
111+
112+
## openapi-common 1.1.1, 2022-07-15
113+
114+
### New features
115+
116+
* [Issue #220](https://github.com/ansys/openapi-common/issues/220),
117+
[Pull request #221](https://github.com/ansys/openapi-common/pull/221):
118+
Handle `Enum` objects as properties of models.
119+
120+
121+
### Contributors
122+
123+
* Doug Addy (Ansys)
124+
125+
126+
## openapi-common 1.1.0, 2022-04-04
127+
128+
### Bugs fixed
129+
130+
* [Issue #170](https://github.com/ansys/openapi-common/issues/170),
131+
[Pull request #180](https://github.com/ansys/openapi-common/pull/180):
132+
Respect `response_type` when deserializing a JSON response.
133+
* [Issue #171](https://github.com/ansys/openapi-common/issues/171),
134+
[Pull request #172](https://github.com/ansys/openapi-common/pull/172):
135+
Fix path parameter formatting in requests.
136+
* [Issue #145](https://github.com/ansys/openapi-common/issues/145),
137+
[Pull request #146](https://github.com/ansys/openapi-common/pull/146):
138+
Fix error message for missing OIDC and kerberos extras.
139+
140+
### Documentation
141+
142+
* Standardize the syntax for different authentication types.
143+
144+
### Contributors
145+
146+
* Doug Addy (Ansys)
147+
* Andy Grigg (Ansys)
148+
* Ludovic Steinbach (Ansys)
149+
* Kathy Pippert (Ansys)

CODE_OF_CONDUCT.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
In the interest of fostering an open and welcoming environment, we as
6+
contributors and maintainers pledge to making participation in our
7+
project and our community a harassment-free experience for everyone,
8+
regardless of age, body size, disability, ethnicity, sex
9+
characteristics, gender identity and expression, level of experience,
10+
education, socio-economic status, nationality, personal appearance,
11+
race, religion, or sexual identity and orientation.
12+
13+
## Our Standards
14+
15+
Examples of behavior that contributes to creating a positive environment
16+
include:
17+
18+
* Using welcoming and inclusive language
19+
* Being respectful of differing viewpoints and experiences
20+
* Gracefully accepting constructive criticism
21+
* Focusing on what is best for the community
22+
* Showing empathy towards other community members
23+
24+
Examples of unacceptable behavior by participants include:
25+
26+
* The use of sexualized language or imagery and unwelcome sexual
27+
attention or advances
28+
* Trolling, insulting/derogatory comments, and personal or political attacks
29+
* Public or private harassment
30+
* Publishing others' private information, such as a physical or electronic
31+
address, without explicit permission
32+
* Other conduct which could reasonably be considered inappropriate in a
33+
professional setting
34+
35+
## Our Responsibilities
36+
37+
Project maintainers are responsible for clarifying the standards of acceptable
38+
behavior and are expected to take appropriate and fair corrective action in
39+
response to any instances of unacceptable behavior.
40+
41+
Project maintainers have the right and responsibility to remove, edit, or reject
42+
comments, commits, code, wiki edits, issues, and other contributions that are
43+
not aligned to this Code of Conduct, or to ban temporarily or permanently any
44+
contributor for other behaviors that they deem inappropriate, threatening,
45+
offensive, or harmful.
46+
47+
## Scope
48+
49+
This Code of Conduct applies both within project spaces and in public spaces
50+
when an individual is representing the project or its community. Examples of
51+
representing a project or community include using an official project e-mail
52+
address, posting via an official social media account, or acting as an appointed
53+
representative at an online or offline event. Representation of a project may be
54+
further defined and clarified by project maintainers.
55+
56+
## Attribution
57+
58+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
59+
version 1.4, available at
60+
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
61+
62+
[homepage]: https://www.contributor-covenant.org
63+
64+
For answers to common questions about this code of conduct, see
65+
https://www.contributor-covenant.org/faq

CONTRIBUTING.md

+2-14
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,5 @@
11
# Contributing
22

3-
Code contributions are welcome. The objective of the OpenAPI-Common
4-
documentation is to facilitate an understanding
5-
of the PyAnsys ``openapi-common`` repository.
3+
Refer to the [PyAnsys Developer's Guide] for contributing to this project.
64

7-
It is important to note that this Python package is maintained
8-
by Ansys and any submission is reviewed thoroughly before merging.
9-
However, we still seek to foster a community that can support
10-
user questions and develop new features to make this package
11-
useful for all users. Thus, both questions and submissions
12-
to this repository are welcomed and encouraged.
13-
14-
For more information about contributing to this project and the build
15-
and testing process, see the "Contribute" topic in the documentation.
16-
For information about PyAnsys development guidelines and the PyAnsys project
17-
as a whole, see the [PyAnsys Developer's Guide](https://github.com/pyansys/about).
5+
[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html

CONTRIBUTORS.md

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
## Project Lead
2+
3+
* [Andy Grigg](https://github.com/Andy-Grigg)
4+
5+
## Contributors
6+
7+
* [Doug Addy](https://github.com/da1910)
8+
* [Ludovic Steinbach](https://github.com/ludovicsteinbach)

0 commit comments

Comments
 (0)