Skip to content

Commit 1a2eb2f

Browse files
sufyankhanraosufyankhanrao
committed
updates documentation for newly added classes
1 parent 5dda7b6 commit 1a2eb2f

3 files changed

Lines changed: 33 additions & 25 deletions

File tree

‎.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -159,3 +159,4 @@ cython_debug/
159159
# option (not recommended) you can uncomment the following to ignore the entire idea folder.
160160
.idea/
161161
*.py~
162+
*~

‎README.md‎

Lines changed: 31 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,46 @@
11
# apimatic-core-interfaces
2-
[![PyPI][pypi-version]](https://pypi.org/project/apimatic-core-interfaces/)
3-
[![Maintainability Rating][maintainability-badge]][maintainability-url]
4-
[![Vulnerabilities][vulnerabilities-badge]][vulnerabilities-url]
2+
[![PyPI][pypi-version]](https://pypi.org/project/apimatic-core-interfaces/)
3+
[![Maintainability Rating][maintainability-badge]][maintainability-url]
4+
[![Vulnerabilities][vulnerabilities-badge]][vulnerabilities-url]
55
[![Licence][license-badge]][license-url]
66

77
## Introduction
8-
This project contains the abstract layer for APIMatic's core library. The purpose of creating interfaces is to separate out the functionalities needed by APIMatic's core library module. The goal is to support scalability and feature enhancement of the core library and the SDKs along with avoiding any breaking changes by reducing tight coupling between modules through the introduction of interfaces.
8+
This project contains the abstract layer for APIMatic's core library. The purpose of creating interfaces is to separate out the functionalities needed by APIMatic's core library module. The goal is to support scalability and feature enhancement of the core library and the SDKs, while avoiding breaking changes by reducing tight coupling between modules.
99

10-
## Version supported
11-
Currenty APIMatic supports `Python version 3.7+` hence the apimatic-core-interfaces will need the same versions to be supported.
10+
## Version Supported
11+
Currently, APIMatic supports **Python version 3.7+**, hence the `apimatic-core-interfaces` package requires the same version support.
1212

1313
## Installation
14-
Simply run the command below in your SDK as the apimatic-core-interfaces will be added as a dependency in the SDK.
15-
```python
14+
Run the following command in your SDK (the `apimatic-core-interfaces` package will be added as a dependency):
15+
```bash
1616
pip install apimatic-core-interfaces
1717
```
1818

1919
## Interfaces
20-
| Name | Description |
21-
|-----------------------------------------------------------------------------|-------------------------------------------------------------------------------------------|
22-
| [`HttpClient`](apimatic_core_interfaces/client/http_client.py) | To save both Request and Response after the completion of response |
23-
| [`ResponseFactory`](apimatic_core_interfaces/factories/response_factory.py) | To convert the client-adapter response into a custom HTTP response |
24-
| [`Authentication`](apimatic_core_interfaces/types/authentication.py) | To setup methods for the validation and application of the required authentication scheme |
25-
| [`UnionType`](apimatic_core_interfaces/types/union_type.py) | To setup methods for the validation and deserialization of OneOf/AnyOf union types |
26-
| [`Logger`](apimatic_core_interfaces/logger/logger.py) | An interface for the generic logger facade |
27-
| [`ApiLogger`](apimatic_core_interfaces/logger/api_logger.py) | An interface for logging API requests and responses |
20+
| Name | Description |
21+
|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
22+
| [`HttpClient`](apimatic_core_interfaces/client/http_client.py) | Saves both request and response after the completion of response. |
23+
| [`ResponseFactory`](apimatic_core_interfaces/factories/response_factory.py) | Converts the client-adapter response into a custom HTTP response. |
24+
| [`Authentication`](apimatic_core_interfaces/types/authentication.py) | Sets up methods for the validation and application of the required authentication scheme. |
25+
| [`UnionType`](apimatic_core_interfaces/types/union_type.py) | Sets up methods for the validation and deserialization of OneOf/AnyOf union types. |
26+
| [`Logger`](apimatic_core_interfaces/logger/logger.py) | An interface for the generic logger facade. |
27+
| [`ApiLogger`](apimatic_core_interfaces/logger/api_logger.py) | An interface for logging API requests and responses. |
28+
29+
## Security
30+
| Name | Description |
31+
|--------------------------------------------------------------------------------------------|---------------------------------------------------------------------------------------------|
32+
| [`SignatureVerifier`](apimatic_core_interfaces/security/signature_verifier.py) | Defines the contract for verifying the authenticity of incoming events or webhook requests. |
33+
| [`VerificationResult`](apimatic_core_interfaces/security/verification_result.py) | Provides a structured result of the verification process, including success, failure, and error details. |
2834

2935
## Enumerations
30-
| Name | Description |
31-
|-------------------------------------------------------------------------------|-----------------------------------------------------------------|
32-
| [`HttpMethodEnum`](apimatic_core_interfaces/types/http_method_enum.py ) | Enumeration containig HTTP Methods (GET, POST, PATCH, DELETE) |
36+
| Name | Description |
37+
|----------------------------------------------------------------------------------------|---------------------------------------------------------------|
38+
| [`HttpMethodEnum`](apimatic_core_interfaces/types/http_method_enum.py) | Enumeration containing HTTP methods (GET, POST, PATCH, DELETE).|
3339

34-
[pypi-version]: https://img.shields.io/pypi/v/apimatic-core-interfaces
35-
[license-badge]: https://img.shields.io/badge/licence-MIT-blue
36-
[license-url]: LICENSE
37-
[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-python&metric=sqale_rating
38-
[maintainability-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-interfaces-python
39-
[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-python&metric=vulnerabilities
40+
[pypi-version]: https://img.shields.io/pypi/v/apimatic-core-interfaces
41+
[license-badge]: https://img.shields.io/badge/licence-MIT-blue
42+
[license-url]: LICENSE
43+
[maintainability-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-python&metric=sqale_rating
44+
[maintainability-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-interfaces-python
45+
[vulnerabilities-badge]: https://sonarcloud.io/api/project_badges/measure?project=apimatic_core-interfaces-python&metric=vulnerabilities
4046
[vulnerabilities-url]: https://sonarcloud.io/summary/new_code?id=apimatic_core-interfaces-python

‎apimatic_core_interfaces/security/__init__.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
11
__all__ = [
22
'signature_verifier',
3+
'verification_result'
34
]

0 commit comments

Comments
 (0)