Skip to main content

DOCUMENTATION

Project description

dushibian-strapi-client

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

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

  • API version: 1.0.0
  • Package version: 1.0.0
  • Generator version: 7.8.0
  • Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit mywebsite.io

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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:

import dushibian_strapi_client

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 dushibian_strapi_client

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import dushibian_strapi_client
from dushibian_strapi_client.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:1337/api
# See configuration.py for a list of all supported configuration parameters.
configuration = dushibian_strapi_client.Configuration(
    host = "http://localhost:1337/api"
)

# 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 Bearer authorization (JWT): bearerAuth
configuration = dushibian_strapi_client.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with dushibian_strapi_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = dushibian_strapi_client.ActivityApi(api_client)
    id = 3.4 # float | 

    try:
        api_response = await api_instance.delete_activities_id(id)
        print("The response of ActivityApi->delete_activities_id:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActivityApi->delete_activities_id: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:1337/api

Class Method HTTP request Description
ActivityApi delete_activities_id DELETE /activities/{id}
ActivityApi get_activities GET /activities
ActivityApi get_activities_id GET /activities/{id}
ActivityApi post_activities POST /activities
ActivityApi put_activities_id PUT /activities/{id}
ArticleApi delete_articles_id DELETE /articles/{id}
ArticleApi get_articles GET /articles
ArticleApi get_articles_id GET /articles/{id}
ArticleApi post_articles POST /articles
ArticleApi put_articles_id PUT /articles/{id}
BookApi delete_books_id DELETE /books/{id}
BookApi get_books GET /books
BookApi get_books_id GET /books/{id}
BookApi post_books POST /books
BookApi put_books_id PUT /books/{id}
HomeApi delete_home DELETE /home
HomeApi get_home GET /home
HomeApi put_home PUT /home
PersonApi delete_people_id DELETE /people/{id}
PersonApi get_people GET /people
PersonApi get_people_id GET /people/{id}
PersonApi post_people POST /people
PersonApi put_people_id PUT /people/{id}
RecommendApi delete_recommends_id DELETE /recommends/{id}
RecommendApi get_recommends GET /recommends
RecommendApi get_recommends_id GET /recommends/{id}
RecommendApi post_recommends POST /recommends
RecommendApi put_recommends_id PUT /recommends/{id}
SiteconfigApi delete_siteconfig DELETE /siteconfig
SiteconfigApi get_siteconfig GET /siteconfig
SiteconfigApi put_siteconfig PUT /siteconfig
TagApi delete_tags_id DELETE /tags/{id}
TagApi get_tags GET /tags
TagApi get_tags_id GET /tags/{id}
TagApi post_tags POST /tags
TagApi put_tags_id PUT /tags/{id}
UploadFileApi upload_files_get GET /upload/files
UploadFileApi upload_files_id_delete DELETE /upload/files/{id}
UploadFileApi upload_files_id_get GET /upload/files/{id}
UploadFileApi upload_post POST /upload
UploadFileApi uploadidid_post POST /upload?id={id}
UsersPermissionsAuthApi auth_change_password_post POST /auth/change-password Update user's own password
UsersPermissionsAuthApi auth_email_confirmation_get GET /auth/email-confirmation Confirm user email
UsersPermissionsAuthApi auth_forgot_password_post POST /auth/forgot-password Send rest password email
UsersPermissionsAuthApi auth_local_post POST /auth/local Local login
UsersPermissionsAuthApi auth_local_register_post POST /auth/local/register Register a user
UsersPermissionsAuthApi auth_provider_callback_get GET /auth/{provider}/callback Default Callback from provider auth
UsersPermissionsAuthApi auth_reset_password_post POST /auth/reset-password Rest user password
UsersPermissionsAuthApi auth_send_email_confirmation_post POST /auth/send-email-confirmation Send confirmation email
UsersPermissionsAuthApi connect_provider_get GET /connect/{provider} Login with a provider
UsersPermissionsUsersRolesApi users_count_get GET /users/count Get user count
UsersPermissionsUsersRolesApi users_get GET /users Get list of users
UsersPermissionsUsersRolesApi users_id_delete DELETE /users/{id} Delete a user
UsersPermissionsUsersRolesApi users_id_get GET /users/{id} Get a user
UsersPermissionsUsersRolesApi users_id_put PUT /users/{id} Update a user
UsersPermissionsUsersRolesApi users_me_get GET /users/me Get authenticated user info
UsersPermissionsUsersRolesApi users_permissions_permissions_get GET /users-permissions/permissions Get default generated permissions
UsersPermissionsUsersRolesApi users_permissions_roles_get GET /users-permissions/roles List roles
UsersPermissionsUsersRolesApi users_permissions_roles_id_get GET /users-permissions/roles/{id} Get a role
UsersPermissionsUsersRolesApi users_permissions_roles_post POST /users-permissions/roles Create a role
UsersPermissionsUsersRolesApi users_permissions_roles_role_delete DELETE /users-permissions/roles/{role} Delete a role
UsersPermissionsUsersRolesApi users_permissions_roles_role_put PUT /users-permissions/roles/{role} Update a role
UsersPermissionsUsersRolesApi users_post POST /users Create a user

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (JWT)

Author

contact-email@something.io

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

dushibian_strapi_client-1.0.0-py3-none-any.whl (317.4 kB view details)

Uploaded Python 3

File details

Details for the file dushibian_strapi_client-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for dushibian_strapi_client-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6e67c071709c20939df91dcb175b31a55dfa7bc554386d21f2498940e7727dc1
MD5 1b798659b30b110bc750e9b0390a0edf
BLAKE2b-256 7161fcddb139b0a4a91740b1aced772124de03c8dc49b069d6ac0963ec9c389e

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page