Skip to content

gridly-spreadsheet-CMS/gridly-python-sdk

BranchesTags

Repository files navigation

gridly

Gridly API documentation

This Python package is automatically generated by the OpenAPI Generator project:

  • API version: 5.9.0
  • Package version: 1.4.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://www.gridly.com

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:

pip install git+https://github.com/gridly-spreadsheet-CMS/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/gridly-spreadsheet-CMS/GIT_REPO_ID.git)

Then import the package:

import gridly

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import gridly

Getting Started

Please follow the installation procedure and then run the following:

import time
import gridly
from pprint import pprint
from gridly.apis.tags import path_api
from gridly.model.create_path import CreatePath
from gridly.model.delete_path import DeletePath
from gridly.model.move_path import MovePath
from gridly.model.path_list import PathList
from gridly.model.path_node import PathNode
from gridly.model.path_single import PathSingle
from gridly.model.update_path import UpdatePath
# Defining the host is optional and defaults to https://api.gridly.com
# See configuration.py for a list of all supported configuration parameters.
configuration = gridly.Configuration(
    host = "https://api.gridly.com"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: ApiKey
configuration.api_key['ApiKey'] = 'YOUR_API_KEY'

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['ApiKey'] = 'Bearer'

# Enter a context with an instance of the API client
with gridly.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = path_api.PathApi(api_client)
    view_id = "viewId_example" # str | viewId
root_path = "rootPath_example" # str | rootPath (optional)

    try:
        # list
        api_response = api_instance.call_list(view_idroot_path=root_path)
        pprint(api_response)
    except gridly.ApiException as e:
        print("Exception when calling PathApi->call_list: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.gridly.com

Class Method HTTP request Description
PathApi call_list get /v1/views/{viewId}/paths/tree list
PathApi create post /v1/views/{viewId}/paths create
PathApi delete delete /v1/views/{viewId}/paths delete
PathApi move post /v1/views/{viewId}/paths/move move
PathApi update put /v1/views/{viewId}/paths/{path} update
BranchApi call_list get /v1/branches list
BranchApi create post /v1/branches create
BranchApi create_diff_check post /v1/branches/diffcheck createDiffCheck
BranchApi delete delete /v1/branches/{branchId} delete
BranchApi get get /v1/branches/{branchId} get
BranchApi get_diff_check get /v1/branches/diffcheck/{taskId} getDiffCheck
BranchApi merge post /v1/branches/{branchId}/merge merge
CdnApi call_list get /v1/cdns list
CdnApi publish put /v1/cdns/{cdnId}/publish publish
CdnApi un_publish put /v1/cdns/{cdnId}/unpublish unPublish
DatabaseApi call_list get /v1/databases list
DatabaseApi create post /v1/databases create
DatabaseApi delete delete /v1/databases/{dbId} delete
DatabaseApi duplicate post /v1/databases/{dbId}/duplicate duplicate
DatabaseApi get get /v1/databases/{dbId} get
DatabaseApi update put /v1/databases/{dbId} update
GlossaryApi create post /v1/glossaries Create a new glossary
GlossaryApi delete delete /v1/glossaries/{id} Delete a glossary
GlossaryApi export_file get /v1/glossaries/{id}/export Export a glossary
GlossaryApi get get /v1/glossaries/{id} get glossary info
GlossaryApi get_all get /v1/glossaries List all glossaries
GlossaryApi import_file post /v1/glossaries/{id}/import Import a glossary from file
GlossaryApi update put /v1/glossaries/{id} Update glossary info
GridApi call_list get /v1/grids list
GridApi create post /v1/grids create
GridApi create_category post /v1/grids/{gridId}/settings/categories createCategory
GridApi delete delete /v1/grids/{gridId} delete
GridApi delete_category delete /v1/grids/{gridId}/settings/categories/{categoryId} deleteCategory
GridApi delete_file delete /v1/grids/{gridId}/settings/categories/{categoryId}/files/{fileId} deleteFile
GridApi get get /v1/grids/{gridId} get
GridApi get_setting get /v1/grids/{gridId}/settings getSetting
GridApi list_files get /v1/grids/{gridId}/settings/files listFiles
GridApi list_template_grids get /v1/template-grids listTemplateGrids
GridApi update patch /v1/grids/{gridId} update
GridApi update_category put /v1/grids/{gridId}/settings/categories/{categoryId} updateCategory
GridApi update_setting patch /v1/grids/{gridId}/settings updateSetting
GridApi upload_setting_file post /v1/grids/{gridId}/settings/categories/{categoryId}/files uploadSettingFile
ProjectApi call_list get /v1/projects list
ProjectApi create post /v1/projects create
ProjectApi delete delete /v1/projects/{projectId} delete
ProjectApi find_one get /v1/projects/{projectId} findOne
ProjectApi update put /v1/projects/{projectId} update
RecordApi create post /v1/views/{viewId}/records create
RecordApi delete delete /v1/views/{viewId}/records delete
RecordApi fetch get /v1/views/{viewId}/records fetch
RecordApi fetch_histories get /v1/views/{viewId}/records/{recordId}/histories fetchHistories
RecordApi update patch /v1/views/{viewId}/records update
RecordApi update_record patch /v1/views/{viewId}/records/{id} updateRecord
ShareViewApi create put /v1/views/{viewId}/shares create
ShareViewApi delete delete /v1/views/{viewId}/shares delete
ShareViewApi get get /v1/views/{viewId}/shares get
TaskApi get get /v1/tasks/{taskId} get
TransmemApi cleanup put /v1/transmems/{tmId}/cleanup Erases all the translation data of the provided tmId
TransmemApi create post /v1/transmems Create a new translation memory
TransmemApi create_with_file post /v1/transmems/upload Create a new translation memory by uploading tmx file
TransmemApi delete delete /v1/transmems/{tmId} Delete a translation memory by id
TransmemApi export get /v1/transmems/{tmId}/export Export translation memory tmx file
TransmemApi get get /v1/transmems/{tmId} Get translation memory info by id
TransmemApi import_tmx post /v1/transmems/{tmId}/import Import a translation memory from tmx file
TransmemApi list_tm get /v1/transmems List all available translation memories or create default one if there is no translation memory
TransmemApi update put /v1/transmems/{tmId} Update a translation memory
ViewApi call_list get /v1/views list
ViewApi create post /v1/views create
ViewApi export get /v1/views/{viewId}/export export
ViewApi get get /v1/views/{viewId} get
ViewApi get_statistic get /v1/views/{viewId}/statistic getStatistic
ViewApi import_view post /v1/views/{viewId}/import importView
ViewApi merge post /v1/views/{viewId}/merge merge
ViewColumnApi add post /v1/views/{viewId}/columns/{columnId}/add add
ViewColumnApi bulk_create post /v1/views/{viewId}/columns/bulk bulkCreate
ViewColumnApi create post /v1/views/{viewId}/columns create
ViewColumnApi delete delete /v1/views/{viewId}/columns/{columnId} delete
ViewColumnApi get get /v1/views/{viewId}/columns/{columnId} get
ViewColumnApi remove post /v1/views/{viewId}/columns/{columnId}/remove remove
ViewColumnApi update patch /v1/views/{viewId}/columns/{columnId} update
ViewDependencyApi call_list get /v1/views/{viewId}/dependencies list
ViewDependencyApi create post /v1/views/{viewId}/dependencies create
ViewDependencyApi delete delete /v1/views/{viewId}/dependencies delete
ViewDependencyApi delete_by_id delete /v1/views/{viewId}/dependencies/{dependencyId} deleteById
ViewDependencyApi get get /v1/views/{viewId}/dependencies/{dependencyId} get
ViewDependencyApi update put /v1/views/{viewId}/dependencies/{dependencyId} update
ViewFileApi delete delete /v1/views/{viewId}/files delete
ViewFileApi download get /v1/views/{viewId}/files/{fileId} download
ViewFileApi upload post /v1/views/{viewId}/files upload
ViewFileApi upload_zip post /v1/views/{viewId}/files/zip uploadZip

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

ApiKey

  • Type: API key
  • API key parameter name: Authorization
  • Location: HTTP header

Author

support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com support@gridly.com

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in gridly.apis and gridly.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 gridly.apis.default_api import DefaultApi
  • from gridly.model.pet import Pet

Solution 1: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import gridly
from gridly.apis import *
from gridly.models import *

About

No description, website, or topics provided.

Resources

Readme

License

MIT license
Activity
Custom properties

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases 1

1.2.10 Latest
Nov 23, 2023

Packages

No packages published

Languages