Package: reearthcmsapi
reearthcmsapiReEarth-CMS Integration APIThis Python package is automatically generated by theOpenAPI Generatorproject:API version: 1.0.0Package version: 1.0.0Build package: org.openapitools.codegen.languages.PythonClientCodegenRequirements.Python >=3.7Migration from other generators like python and python-legacyChangesThis 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_caseSo you will need to update how you input and read properties to use spec caseEndpoint parameters are stored in dictionaries to prevent collisions (explanation below)So you will need to update how you pass data in to endpointsEndpoint responses now include the original response, the deserialized response body, and (todo)the deserialized headersSo you will need to update your code to use response.body to access deserialized dataAll validated data is instantiated in an instance that subclasses all validated Schema classes and Decimal/str/list/tuple/frozendict/NoneClass/BoolClass/bytes/io.FileIOThis means that you can use isinstance to check if a payload validated against a schema classThis means that no data will be of type None/True/Falseingested None will subclass NoneClassingested True will subclass BoolClassingested False will subclass BoolClassSo if you need to check is True/False/None, instead use instance.is_true_oapg()/.is_false_oapg()/.is_none_oapg()All validated class instances are immutable except for ones based on io.FileThis is because if properties were changed after validation, that validation would no longer applySo no changing values or property values after a class has been instantiatedString + Number types with formatsString 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 instancetype string + format: See .as_date_oapg, .as_datetime_oapg, .as_decimal_oapg, .as_uuid_oapgtype number + format: See .as_float_oapg, .as_int_oapgthis 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 schemaSo if you need to access a string format based type, use as_date_oapg/as_datetime_oapg/as_decimal_oapg/as_uuid_oapgSo if you need to access a number format based type, use as_int_oapg/as_float_oapgProperty access on AnyType(type unset) or object(dict) schemasOnly required keys with valid python names are properties like .someProp and have type hintsAll optional keys may not exist, so properties are not defined for themOne can access optional values with dict_instance['optionalProp'] and KeyError will be raised if it does not existUse get_item_oapg if you need a way to always get a value whether or not the key existsIf 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 usedA type hint is also generated for additionalProperties accessed using this methodSo you will need to update you code to use some_instance['optionalProp'] to access optional property
and additionalProperty valuesThe location of the api classes has changedApi classes are located in your_package.apis.tags.some_apiThis change was made to eliminate redundant code generationLegacy generators generated the same endpoint twice if it had > 1 tag on itThis generator defines an endpoint in one class, then inherits that class to generate
apis by tags and by pathsThis change reduces code and allows quicker run time if you use the path apispath apis are at your_package.apis.paths.some_pathThose apis will only load their needed models, which is less to load than all of the resources needed in a tag apiSo you will need to update your import paths to the api classesWhy 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 caseThis 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 caseParameters can be included in different locations including:querypathheadercookieAny 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_paramspath_paramsheader_paramscookie_paramsSo when updating your code, you will need to pass endpoint parameters in using those
dictionaries.Endpoint responsesEndpoint 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 addedInstallation & Usagepip installIf the python package is hosted on a repository, you can install directly using:pipinstallgit+https://github.com/GIT_USER_ID/GIT_REPO_ID.git(you may need to runpipwith root permission:sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)Then import the package:importreearthcmsapiSetuptoolsInstall viaSetuptools.pythonsetup.pyinstall--user(orsudo python setup.py installto install the package for all users)Then import the package:importreearthcmsapiGetting StartedPlease follow theinstallation procedureand then run the following:importtimeimportreearthcmsapifrompprintimportpprintfromreearthcmsapi.apis.tagsimportassets_apifromreearthcmsapi.model.assetimportAsset# Defining the host is optional and defaults to http://localhost# See configuration.py for a list of all supported configuration parameters.configuration=reearthcmsapi.Configuration(host="http://localhost")# Enter a context with an instance of the API clientwithreearthcmsapi.ApiClient(configuration)asapi_client:# Create an instance of the API classapi_instance=assets_api.AssetsApi(api_client)asset_id="assetId_example"# str | ID of the selected assettry:api_response=api_instance.asset_delete(asset_id)pprint(api_response)exceptreearthcmsapi.ApiExceptionase:print("Exception when calling AssetsApi->asset_delete:%s\n"%e)Documentation for API EndpointsAll URIs are relative tohttp://localhostClassMethodHTTP requestDescriptionAssetsApiasset_deletedelete/assets/{assetId}AssetsApiasset_getget/assets/{assetId}AssetsCommentsApiasset_comment_createpost/assets/{assetId}/commentsAssetsCommentsApiasset_comment_deletedelete/assets/{assetId}/comments/{commentId}AssetsCommentsApiasset_comment_listget/assets/{assetId}/commentsAssetsCommentsApiasset_comment_updatepatch/assets/{assetId}/comments/{commentId}Update AssetCommentAssetsProjectApiasset_createpost/projects/{projectId}/assetsCreate an new asset.AssetsProjectApiasset_filterget/projects/{projectId}/assetsReturns a list of assets.ItemsApiitem_createpost/models/{modelId}/itemscreate an itemItemsApiitem_deletedelete/items/{itemId}delete an itemItemsApiitem_filterget/models/{modelId}/itemsReturns a list of items.ItemsApiitem_getget/items/{itemId}Returns an items.ItemsApiitem_updatepatch/items/{itemId}Update an item.ItemsCommentsApiitem_comment_createpost/items/{itemId}/commentsItemsCommentsApiitem_comment_deletedelete/items/{itemId}/comments/{commentId}ItemsCommentsApiitem_comment_listget/items/{itemId}/commentsItemsCommentsApiitem_comment_updatepatch/items/{itemId}/comments/{commentId}Update Item CommentItemsProjectApiitem_create_with_projectpost/projects/{projectIdOrAlias}/models/{modelIdOrKey}/itemsItemsProjectApiitem_filter_with_projectget/projects/{projectIdOrAlias}/models/{modelIdOrKey}/itemsReturns a list of items.ModelsApimodel_getget/models/{modelId}Returns a model.ModelsApimodel_get_with_projectget/projects/{projectIdOrAlias}/models/{modelIdOrKey}Returns a model.Documentation For ModelsAssetAssetEmbeddingCommentFieldFileItemModelRefOrVersionSchemaSchemaFieldValueTypeVersionVersionedItemDocumentation For AuthorizationAuthentication schemes defined for the API:bearerAuthType: Bearer authenticationAuthorNotes for Large OpenAPI documentsIf the OpenAPI document is large, imports in reearthcmsapi.apis and reearthcmsapi.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 reearthcmsapi.apis.default_api import DefaultApifrom reearthcmsapi.model.pet import PetSolution 1:
Before importing the package, adjust the maximum recursion limit as shown below:import sys
sys.setrecursionlimit(1500)
import reearthcmsapi
from reearthcmsapi.apis import *
from reearthcmsapi.models import *