From 6c9b900e2069c8070a04cd5d6ec91ccea98197d1 Mon Sep 17 00:00:00 2001 From: Andy Grigg Date: Tue, 20 Feb 2024 12:03:26 -0500 Subject: [PATCH 1/2] Add repo files --- AUTHORS.md | 16 +++++ CHANGELOG.md | 149 +++++++++++++++++++++++++++++++++++++++++++++ CODE_OF_CONDUCT.md | 65 ++++++++++++++++++++ CONTRIBUTING.md | 16 +---- CONTRIBUTORS.md | 8 +++ 5 files changed, 240 insertions(+), 14 deletions(-) create mode 100644 AUTHORS.md create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTORS.md diff --git a/AUTHORS.md b/AUTHORS.md new file mode 100644 index 00000000..b8a3e3f6 --- /dev/null +++ b/AUTHORS.md @@ -0,0 +1,16 @@ +# This is the list of GRANTA MI RecordLists API significant contributors. +# +# This file does not necessarily list everyone who has contributed code, +# especially since many employees of one corporation may be contributing. +# To see the full list of contributors, see the revision history in +# source control. +# +# For contributions made under a Corporate CLA, then the copyright +# belongs to that organization. +# +# If a contribution was made under an Individual CLA, the submitter +# has indicated that they own the copyright. If that is your case, and +# you want to be added to this file, please submit a request. +# +# +ANSYS, Inc. diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 00000000..a55bb94f --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,149 @@ +# Changelog + +## openapi-common 1.4.0, 2024-01-10 + +### New features + +* [Pull request #451](https://github.com/ansys/openapi-common/pull/451): + Move some auto-generated model methods to the base class. + +### Bugs fixed + +* [Issue #443](https://github.com/ansys/openapi-common/issues/443), + [Pull request #447](https://github.com/ansys/openapi-common/pull/447): + `Enum` deserialization now properly instantiates the `Enum`. + +### Documentation + +* [Pull request #457](https://github.com/ansys/openapi-common/pull/457): + Fix Ubuntu 20.04 installation instructions. + +### Contributors + +* Doug Addy (Ansys) +* Andy Grigg (Ansys) +* Ludovic Steinbach (Ansys) + +## openapi-common 1.3.0, 2023-11-13 + +### New features + +* [Issue #311](https://github.com/ansys/openapi-common/issues/311), + [Pull request #312](https://github.com/ansys/openapi-common/pull/312): + Support response type to status code mapping for response deserialization. + +### Bugs fixed + +* [Issue #313](https://github.com/ansys/openapi-common/issues/313), + [Pull request #316](https://github.com/ansys/openapi-common/pull/316): + Improve `ApiConnectionException` error message. +* [Issue #380](https://github.com/ansys/openapi-common/issues/380), + [Pull request #381](https://github.com/ansys/openapi-common/pull/381): + Improve regular expression performance while deserializing response. + +### Miscellaneous + +* [Pull request #347](https://github.com/ansys/openapi-common/pull/347): + Drop support for Python 3.7. +* [Pull request #432](https://github.com/ansys/openapi-common/pull/432): + Drop support for Python 3.8. + +### Contributors + +* Doug Addy (Ansys) +* Andy Grigg (Ansys) +* Ludovic Steinbach (Ansys) + +## openapi-common 1.2.2, 2023-04-14 + +### Bugs fixed + +* [Issue #380](https://github.com/ansys/openapi-common/issues/380), + [Pull request #381](https://github.com/ansys/openapi-common/pull/381): + Improve regular expression performance while deserializing response. + +### Contributors + +* Doug Addy (Ansys) + +## openapi-common 1.2.1, 2023-02-20 + +### New features + +* [Issue #311](https://github.com/ansys/openapi-common/issues/311), + [Pull request #312](https://github.com/ansys/openapi-common/pull/312): + Support response type to status code mapping for response deserialization. + +### Bugs fixed + +* [Issue #313](https://github.com/ansys/openapi-common/issues/313), + [Pull request #316](https://github.com/ansys/openapi-common/pull/316): + Improve `ApiConnectionException` error message. + +### Contributors + +* Andy Grigg (Ansys) +* Ludovic Steinbach (Ansys) + +## openapi-common 1.2.0, 2023-01-03 + +### New features + +* [Issue #220](https://github.com/ansys/openapi-common/issues/220), + [Pull request #221](https://github.com/ansys/openapi-common/pull/221): + Handle `Enum` objects as properties of models. +* [Issue #129](https://github.com/ansys/openapi-common/issues/129), + [Pull request #139](https://github.com/ansys/openapi-common/pull/139): + Replace `requests-oauthlib` with `requests-auth`. + +### Bugs fixed + +* [Issue #284](https://github.com/ansys/openapi-common/issues/284), + [Pull request #288](https://github.com/ansys/openapi-common/pull/288): + Fix formatting path with multiple path parameters. + +### Contributors + +* Doug Addy (Ansys) +* Andy Grigg (Ansys) +* Ludovic Steinbach (Ansys) +* Kathy Pippert (Ansys) + +## openapi-common 1.1.1, 2022-07-15 + +### New features + +* [Issue #220](https://github.com/ansys/openapi-common/issues/220), + [Pull request #221](https://github.com/ansys/openapi-common/pull/221): + Handle `Enum` objects as properties of models. + + +### Contributors + +* Doug Addy (Ansys) + + +## openapi-common 1.1.0, 2022-04-04 + +### Bugs fixed + +* [Issue #170](https://github.com/ansys/openapi-common/issues/170), + [Pull request #180](https://github.com/ansys/openapi-common/pull/180): + Respect `response_type` when deserializing a JSON response. +* [Issue #171](https://github.com/ansys/openapi-common/issues/171), + [Pull request #172](https://github.com/ansys/openapi-common/pull/172): + Fix path parameter formatting in requests. +* [Issue #145](https://github.com/ansys/openapi-common/issues/145), + [Pull request #146](https://github.com/ansys/openapi-common/pull/146): + Fix error message for missing OIDC and kerberos extras. + +### Documentation + +* Standardize the syntax for different authentication types. + +### Contributors + +* Doug Addy (Ansys) +* Andy Grigg (Ansys) +* Ludovic Steinbach (Ansys) +* Kathy Pippert (Ansys) diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 00000000..1cf484f1 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,65 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our +project and our community a harassment-free experience for everyone, +regardless of age, body size, 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. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual + attention or advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, or to ban temporarily or permanently any +contributor for other behaviors that they deem inappropriate, threatening, +offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 1.4, available at +https://www.contributor-covenant.org/version/1/4/code-of-conduct.html + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see +https://www.contributor-covenant.org/faq diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1b1f629b..ba1b0d71 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,17 +1,5 @@ # Contributing -Code contributions are welcome. The objective of the OpenAPI-Common -documentation is to facilitate an understanding -of the PyAnsys ``openapi-common`` repository. +Refer to the [PyAnsys Developer's Guide] for contributing to this project. -It is important to note that this Python package is maintained -by Ansys and any submission is reviewed thoroughly before merging. -However, we still seek to foster a community that can support -user questions and develop new features to make this package -useful for all users. Thus, both questions and submissions -to this repository are welcomed and encouraged. - -For more information about contributing to this project and the build -and testing process, see the "Contribute" topic in the documentation. -For information about PyAnsys development guidelines and the PyAnsys project -as a whole, see the [PyAnsys Developer's Guide](https://github.com/pyansys/about). +[PyAnsys Developer's Guide]: https://dev.docs.pyansys.com/index.html diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md new file mode 100644 index 00000000..cc3f1a4b --- /dev/null +++ b/CONTRIBUTORS.md @@ -0,0 +1,8 @@ +## Project Lead + +* [Andy Grigg](https://github.com/Andy-Grigg) + +## Contributors + +* [Doug Addy](https://github.com/da1910) +* [Ludovic Steinbach](https://github.com/ludovicsteinbach) From bf6fcd0f630270b0ebc4f9724d67d9b57a474cde Mon Sep 17 00:00:00 2001 From: Andy Grigg Date: Tue, 20 Feb 2024 14:09:30 -0500 Subject: [PATCH 2/2] Fix repo name --- AUTHORS.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/AUTHORS.md b/AUTHORS.md index b8a3e3f6..3d89f891 100644 --- a/AUTHORS.md +++ b/AUTHORS.md @@ -1,4 +1,4 @@ -# This is the list of GRANTA MI RecordLists API significant contributors. +# This is the list of OpenAPI Common significant contributors. # # This file does not necessarily list everyone who has contributed code, # especially since many employees of one corporation may be contributing.