# clothes-sdk-ashuk203
This API allows creation and retrieval of clothes
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- API version: 1.0.0
- Package version: 1.0.6
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python >=3.7
## Migration from other generators like python and python-legacy
### Changes
1. This generator uses spec case for all (object) property names and parameter names.
- So if the spec has a property name like camelCase, it will use camelCase rather than camel_case
- So you will need to update how you input and read properties to use spec case
2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)
- So you will need to update how you pass data in to endpoints
3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers
- So you will need to update your code to use response.body to access deserialized data
4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO
- This means that you can use isinstance to check if a payload validated against a schema class
- This means that no data will be of type None/True/False
- ingested None will subclass NoneClass
- ingested True will subclass BoolClass
- ingested False will subclass BoolClass
- So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()
5. All validated class instances are immutable except for ones based on io.File
- This is because if properties were changed after validation, that validation would no longer apply
- So no changing values or property values after a class has been instantiated
6. String + Number types with formats
- String type data is stored as a string and if you need to access types based on its format like date,
date-time, uuid, number etc then you will need to use accessor functions on the instance
- type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg
- type number + format: See .as_float_oapg, .as_int_oapg
- this was done because openapi/json-schema defines constraints. string data may be type string with no format
keyword in one schema, and include a format constraint in another schema
- So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg
- So if you need to access a number format based type, use as_int_oapg/as_float_oapg
7. Property access on AnyType(type unset) or object(dict) schemas
- Only required keys with valid python names are properties like .someProp and have type hints
- All optional keys may not exist, so properties are not defined for them
- One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist
- Use get_item_oapg if you need a way to always get a value whether or not the key exists
- If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')
- All required and optional keys have type hints for this method, and @typing.overload is used
- A type hint is also generated for additionalProperties accessed using this method
- So you will need to update you code to use some_instance['optionalProp'] to access optional property
and additionalProperty values
8. The location of the api classes has changed
- Api classes are located in your_package.apis.tags.some_api
- This change was made to eliminate redundant code generation
- Legacy generators generated the same endpoint twice if it had > 1 tag on it
- This generator defines an endpoint in one class, then inherits that class to generate
apis by tags and by paths
- This change reduces code and allows quicker run time if you use the path apis
- path apis are at your_package.apis.paths.some_path
- Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api
- So you will need to update your import paths to the api classes
### Why are Oapg and _oapg used in class and method names?
Classes can have arbitrarily named properties set on them
Endpoints can have arbitrary operationId method names set
For those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions
on protected + public classes/methods.
oapg stands for OpenApi Python Generator.
### Object property spec case
This was done because when payloads are ingested, they can be validated against N number of schemas.
If the input signature used a different property name then that has mutated the payload.
So SchemaA and SchemaB must both see the camelCase spec named variable.
Also it is possible to send in two properties, named camelCase and camel_case in the same payload.
That use case should be support so spec case is used.
### Parameter spec case
Parameters can be included in different locations including:
- query
- path
- header
- cookie
Any of those parameters could use the same parameter names, so if every parameter
was included as an endpoint parameter in a function signature, they would collide.
For that reason, each of those inputs have been separated out into separate typed dictionaries:
- query_params
- path_params
- header_params
- cookie_params
So when updating your code, you will need to pass endpoint parameters in using those
dictionaries.
### Endpoint responses
Endpoint responses have been enriched to now include more information.
Any response reom an endpoint will now include the following properties:
response: urllib3.HTTPResponse
body: typing.Union[Unset, Schema]
headers: typing.Union[Unset, TODO]
Note: response header deserialization has not yet been added
## Installation & Usage
### pip install
If the python package is hosted on a repository, you can install directly using:
```sh
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)
Then import the package:
```python
import clothes_sdk_ashuk203
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import clothes_sdk_ashuk203
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import time
import clothes_sdk_ashuk203
from pprint import pprint
from clothes_sdk_ashuk203.apis.tags import default_api
from clothes_sdk_ashuk203.model.new_tshirt import NewTshirt
from clothes_sdk_ashuk203.model.tshirt import Tshirt
# Defining the host is optional and defaults to http://localhost:8080
# See configuration.py for a list of all supported configuration parameters.
configuration = clothes_sdk_ashuk203.Configuration(
host = "http://localhost:8080"
)
# Enter a context with an instance of the API client
with clothes_sdk_ashuk203.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = default_api.DefaultApi(api_client)
id = "2" # str | Id of item to create
new_tshirt = NewTshirt(
logo=".",
secret=Size("small"),
) # NewTshirt | (optional)
try:
# Create a tshirt
api_response = api_instance.create_tshirt(idnew_tshirt=new_tshirt)
pprint(api_response)
except clothes_sdk_ashuk203.ApiException as e:
print("Exception when calling DefaultApi->create_tshirt: %s\n" % e)
```
## Documentation for API Endpoints
All URIs are relative to *http://localhost:8080*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DefaultApi* | [**create_tshirt**](docs/apis/tags/DefaultApi.md#create_tshirt) | **post** /tshirts/{id} | Create a tshirt
*DefaultApi* | [**delete_tshirt**](docs/apis/tags/DefaultApi.md#delete_tshirt) | **delete** /tshirts/{id} | Deletes an existing T-shirt
*DefaultApi* | [**get_tshirt**](docs/apis/tags/DefaultApi.md#get_tshirt) | **get** /tshirts/{id} | Gets an existing tshirt
## Documentation For Models
- [ErrorMessage](docs/models/ErrorMessage.md)
- [Id](docs/models/Id.md)
- [Logo](docs/models/Logo.md)
- [NewTshirt](docs/models/NewTshirt.md)
- [Size](docs/models/Size.md)
- [Tshirt](docs/models/Tshirt.md)
## Documentation For Authorization
All endpoints do not require authorization.
## Author
## Notes for Large OpenAPI documents
If the OpenAPI document is large, imports in clothes_sdk_ashuk203.apis and clothes_sdk_ashuk203.models may fail with a
RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:
Solution 1:
Use specific imports for apis and models like:
- `from clothes_sdk_ashuk203.apis.default_api import DefaultApi`
- `from clothes_sdk_ashuk203.model.pet import Pet`
Solution 1:
Before importing the package, adjust the maximum recursion limit as shown below:
```
import sys
sys.setrecursionlimit(1500)
import clothes_sdk_ashuk203
from clothes_sdk_ashuk203.apis import *
from clothes_sdk_ashuk203.models import *
```
Raw data
{
"_id": null,
"home_page": "",
"name": "clothes-sdk-ashuk203",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "OpenAPI,OpenAPI-Generator,Clothes Warehouse",
"author": "Ashutosh Ukey",
"author_email": "ashuk203@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/f1/a1/c4b18cbe987e74c3dd8c42af3f41a84701be646a8cc3c5bbf6e30d44442b/clothes-sdk-ashuk203-1.0.6.tar.gz",
"platform": null,
"description": "# clothes-sdk-ashuk203\nThis API allows creation and retrieval of clothes\n\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.6\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython >=3.7\n\n## Migration from other generators like python and python-legacy\n\n### Changes\n1. This generator uses spec case for all (object) property names and parameter names.\n - So if the spec has a property name like camelCase, it will use camelCase rather than camel_case\n - So you will need to update how you input and read properties to use spec case\n2. Endpoint parameters are stored in dictionaries to prevent collisions (explanation below)\n - So you will need to update how you pass data in to endpoints\n3. Endpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headers\n - So you will need to update your code to use response.body to access deserialized data\n4. All validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIO\n - This means that you can use isinstance to check if a payload validated against a schema class\n - This means that no data will be of type None/True/False\n - ingested None will subclass NoneClass\n - ingested True will subclass BoolClass\n - ingested False will subclass BoolClass\n - So if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()\n5. All validated class instances are immutable except for ones based on io.File\n - This is because if properties were changed after validation, that validation would no longer apply\n - So no changing values or property values after a class has been instantiated\n6. String + Number types with formats\n - String type data is stored as a string and if you need to access types based on its format like date,\n date-time, uuid, number etc then you will need to use accessor functions on the instance\n - type string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapg\n - type number + format: See .as_float_oapg, .as_int_oapg\n - this was done because openapi/json-schema defines constraints. string data may be type string with no format\n keyword in one schema, and include a format constraint in another schema\n - So if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapg\n - So if you need to access a number format based type, use as_int_oapg/as_float_oapg\n7. Property access on AnyType(type unset) or object(dict) schemas\n - Only required keys with valid python names are properties like .someProp and have type hints\n - All optional keys may not exist, so properties are not defined for them\n - One can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not exist\n - Use get_item_oapg if you need a way to always get a value whether or not the key exists\n - If the key does not exist, schemas.unset is returned from calling dict_instance.get_item_oapg('optionalProp')\n - All required and optional keys have type hints for this method, and @typing.overload is used\n - A type hint is also generated for additionalProperties accessed using this method\n - So you will need to update you code to use some_instance['optionalProp'] to access optional property\n and additionalProperty values\n8. The location of the api classes has changed\n - Api classes are located in your_package.apis.tags.some_api\n - This change was made to eliminate redundant code generation\n - Legacy generators generated the same endpoint twice if it had > 1 tag on it\n - This generator defines an endpoint in one class, then inherits that class to generate\n apis by tags and by paths\n - This change reduces code and allows quicker run time if you use the path apis\n - path apis are at your_package.apis.paths.some_path\n - Those apis will only load their needed models, which is less to load than all of the resources needed in a tag api\n - So you will need to update your import paths to the api classes\n\n### Why are Oapg and _oapg used in class and method names?\nClasses can have arbitrarily named properties set on them\nEndpoints can have arbitrary operationId method names set\nFor those reasons, I use the prefix Oapg and _oapg to greatly reduce the likelihood of collisions\non protected + public classes/methods.\noapg stands for OpenApi Python Generator.\n\n### Object property spec case\nThis was done because when payloads are ingested, they can be validated against N number of schemas.\nIf the input signature used a different property name then that has mutated the payload.\nSo SchemaA and SchemaB must both see the camelCase spec named variable.\nAlso it is possible to send in two properties, named camelCase and camel_case in the same payload.\nThat use case should be support so spec case is used.\n\n### Parameter spec case\nParameters can be included in different locations including:\n- query\n- path\n- header\n- cookie\n\nAny of those parameters could use the same parameter names, so if every parameter\nwas included as an endpoint parameter in a function signature, they would collide.\nFor that reason, each of those inputs have been separated out into separate typed dictionaries:\n- query_params\n- path_params\n- header_params\n- cookie_params\n\nSo when updating your code, you will need to pass endpoint parameters in using those\ndictionaries.\n\n### Endpoint responses\nEndpoint responses have been enriched to now include more information.\nAny response reom an endpoint will now include the following properties:\nresponse: urllib3.HTTPResponse\nbody: typing.Union[Unset, Schema]\nheaders: typing.Union[Unset, TODO]\nNote: response header deserialization has not yet been added\n\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n```python\nimport clothes_sdk_ashuk203\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n```python\nimport clothes_sdk_ashuk203\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\n\nimport time\nimport clothes_sdk_ashuk203\nfrom pprint import pprint\nfrom clothes_sdk_ashuk203.apis.tags import default_api\nfrom clothes_sdk_ashuk203.model.new_tshirt import NewTshirt\nfrom clothes_sdk_ashuk203.model.tshirt import Tshirt\n# Defining the host is optional and defaults to http://localhost:8080\n# See configuration.py for a list of all supported configuration parameters.\nconfiguration = clothes_sdk_ashuk203.Configuration(\n host = \"http://localhost:8080\"\n)\n\n\n# Enter a context with an instance of the API client\nwith clothes_sdk_ashuk203.ApiClient(configuration) as api_client:\n # Create an instance of the API class\n api_instance = default_api.DefaultApi(api_client)\n id = \"2\" # str | Id of item to create\nnew_tshirt = NewTshirt(\n logo=\".\",\n secret=Size(\"small\"),\n ) # NewTshirt | (optional)\n\n try:\n # Create a tshirt\n api_response = api_instance.create_tshirt(idnew_tshirt=new_tshirt)\n pprint(api_response)\n except clothes_sdk_ashuk203.ApiException as e:\n print(\"Exception when calling DefaultApi->create_tshirt: %s\\n\" % e)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *http://localhost:8080*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**create_tshirt**](docs/apis/tags/DefaultApi.md#create_tshirt) | **post** /tshirts/{id} | Create a tshirt\n*DefaultApi* | [**delete_tshirt**](docs/apis/tags/DefaultApi.md#delete_tshirt) | **delete** /tshirts/{id} | Deletes an existing T-shirt\n*DefaultApi* | [**get_tshirt**](docs/apis/tags/DefaultApi.md#get_tshirt) | **get** /tshirts/{id} | Gets an existing tshirt\n\n## Documentation For Models\n\n - [ErrorMessage](docs/models/ErrorMessage.md)\n - [Id](docs/models/Id.md)\n - [Logo](docs/models/Logo.md)\n - [NewTshirt](docs/models/NewTshirt.md)\n - [Size](docs/models/Size.md)\n - [Tshirt](docs/models/Tshirt.md)\n\n## Documentation For Authorization\n\n All endpoints do not require authorization.\n\n## Author\n\n\n\n## Notes for Large OpenAPI documents\nIf the OpenAPI document is large, imports in clothes_sdk_ashuk203.apis and clothes_sdk_ashuk203.models may fail with a\nRecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:\n\nSolution 1:\nUse specific imports for apis and models like:\n- `from clothes_sdk_ashuk203.apis.default_api import DefaultApi`\n- `from clothes_sdk_ashuk203.model.pet import Pet`\n\nSolution 1:\nBefore importing the package, adjust the maximum recursion limit as shown below:\n```\nimport sys\nsys.setrecursionlimit(1500)\nimport clothes_sdk_ashuk203\nfrom clothes_sdk_ashuk203.apis import *\nfrom clothes_sdk_ashuk203.models import *\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Python SDK for (dummy) Clothes APIs",
"version": "1.0.6",
"split_keywords": [
"openapi",
"openapi-generator",
"clothes warehouse"
],
"urls": [
{
"comment_text": "",
"digests": {
"md5": "1070048962aae2053e06e831a0555744",
"sha256": "923fc8cca1072e9b740cd02f96441b91e9b9021c35bb290f8e5a6218c5cf15a4"
},
"downloads": -1,
"filename": "clothes_sdk_ashuk203-1.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "1070048962aae2053e06e831a0555744",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 62902,
"upload_time": "2022-12-08T16:57:34",
"upload_time_iso_8601": "2022-12-08T16:57:34.568527Z",
"url": "https://files.pythonhosted.org/packages/f2/8a/1b696dc42bf13c9b121b870fd98be773671514291d066bf8101941975c7f/clothes_sdk_ashuk203-1.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"md5": "7c1965659f9a8ac2118d846d9ffeda36",
"sha256": "c12bd031848f8e3636d2a0c1b92ddc68ddbc34e4c18f4f945f2d8473e6820540"
},
"downloads": -1,
"filename": "clothes-sdk-ashuk203-1.0.6.tar.gz",
"has_sig": false,
"md5_digest": "7c1965659f9a8ac2118d846d9ffeda36",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 50461,
"upload_time": "2022-12-08T16:57:35",
"upload_time_iso_8601": "2022-12-08T16:57:35.749148Z",
"url": "https://files.pythonhosted.org/packages/f1/a1/c4b18cbe987e74c3dd8c42af3f41a84701be646a8cc3c5bbf6e30d44442b/clothes-sdk-ashuk203-1.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-12-08 16:57:35",
"github": false,
"gitlab": false,
"bitbucket": false,
"lcname": "clothes-sdk-ashuk203"
}
JSON