Skip to content

Releases: stolenvw/pyPalworldAPI

pyPalworldAPI-v0.0.7

23 Dec 06:14
0522298
Compare
Choose a tag to compare

pyPalworldAPI-v0.0.6

30 Nov 17:19
6b96488
Compare
Choose a tag to compare

Added

  • Game data from v0.3.6
  • Get autocomplete to help with discord bots slash command autocomplete
    GET /autocomplete/{category}/?name=
  • Container for user database, that uses a different storage volume (db-user-data). This allows you to delete the db-data volume when doing updates to get the new api data without losing all the user accounts. *Only made if COMPOSE_PROFILES is set to USE_OAUTH2.
  • Environment variables for OAuth
    • MYSQL_USER_DATABASE Database to store user accounts.
    • SQL_USER_HOST MySQL host for user accounts.
    • COMPOSE_PROFILES To use OAuth set to USE_OAUTH2 else leave blank.
    • SECRET_KEY Used for making tokens.
    • ACCESS_TOKEN_EXPIRE_MINUTES How many minutes should a access token be valid for.
    • REFRESH_TOKEN_EXPIRE_DAYS How many days should a refresh token be valid for. When refreshing an access token a new refresh token will be issued if its getting close to expiring.
    • ADMIN_NAME Name of admin account that will be auto made if users table does not already exist, will be made with a default password of pyPalworldAPI
  • API endpoints for OAuth
    • /oauth2/login/ Used to login and get an access and refresh token. *Logging in again will make all current access/refresh tokens invalid.
    • /oauth2/refresh/ Used to get new access token after current one expired, will also give new refresh token if its close to expiring.
    • /oauth2/validate Used to check if access token is still valid.
    • /user/changepassword/ Allows users with APIUser:ChangePassword scope to change there password. *Will make all current access/refresh tokens invalid.
    • /user/me/ Allows users with APIUser:Read scope to get username and scopes associated with the access token there using.
    • /admin/adduser/ Allows user with APIAdmin:Write scope to add new users.
    • /admin/chpass/ Allows user with APIAdmin:Write scope to change other users passwords. *Will make all there current access/refresh tokens invalid.
    • /admin/deleteuser/ Allows user with APIAdmin:Write scope to delete a user.
    • /admin/users/ Allows user with APIAdmin:Write scope to list all users in the database.
    • /admin/userdisable/ Allows user with APIAdmin:Write scope to disable a users account.
    • /admin/chscope/ Allows user with APIAdmin:Write scope to change a users scopes.
  • OAuth scopes
    • APIAdmin:Write Needed to use /admin/* endpoints.
    • APIUser:Read Needed to get info from API.
    • APIUser:ChangePassword Needed to use /user/changepassword/ endpoint.
  • Curl and Python request samples to the /redoc URL.

Changed

  • api folder name to pyPalworldAPI (Posable breaking change for people not using docker.)
  • bcrypt to version 4.2.0
  • fastapi to version 0.111.1
  • fastapi-pagination to version 0.12.26
  • pydantic to version 2.8.2
  • SQLAlchemy to version 2.0.31
  • sqlmodel to version 0.0.21
  • uvicorn to version 0.30.4
  • Most of the error returns to be format shown below, (Validation Error is still the same.)
    {
        "status": 0,
        "message": "string"
    }

Full Changelog: v0.0.5...v0.0.6

pyPalworldAPI-v0.0.5

27 Jun 11:34
aba862b
Compare
Choose a tag to compare

Changed

  • "Boss" Pals HP, EnemyReceiveDamageRate, EnemyInflictDamageRate to new values from v0.2.4.0

Full Changelog: v0.0.4...v0.0.5

pyPalworldAPI-v0.0.4

14 May 21:24
5dc9409
Compare
Choose a tag to compare

Added

  • Game data from v0.2.2.0

Changed

  • ITEM_NAME_PalSummon name from "Bellanoir's Slab" to "Summoning Altar"

Full Changelog: v0.0.3...v0.0.4

pyPalworldAPI-v0.0.3

14 Apr 12:57
6206208
Compare
Choose a tag to compare

Added

  • Game data from v0.2.0.6
  • Items passive skills
  • Pal stats:
    • EnemyMaxHPRate
    • EnemyReceiveDamageRate
    • EnemyInflictDamageRate
  • Pals IsRaidBoss
  • BossPals IsRaidBoss
  • FoodEffects Interaval
  • SickPal RecoveryProbabilityPercentageInPalBox
  • NPC IsRaidBoss
  • Elixir
  • New Breeding data (have checked some of them, if you find ones that are wrong let me know)

Changed

  • Some images to new version from v0.2.0.6

Full Changelog: v0.0.2...v0.0.3

pyPalworldAPI-v0.0.2

13 Mar 20:14
46b89d5
Compare
Choose a tag to compare

Added

  • Get paginate return of full category
    GET /all/{category}
  • NPC information.

Changed

  • fastapi to version 0.110.0
  • fastapi-pagination to version 0.12.19
  • pydantic to version 2.6.3
  • SQLAlchemy to version 2.0.28
  • uvicorn to version 0.28.0
  • get pals to take multiple params to filter results more
  • get bosspals to take multiple params to filter results more

Fixed

  • Docs successful response example value, to show example instead of just "string"

pyPalworldAPI-v0.0.1

08 Mar 22:22
8e77e7a
Compare
Choose a tag to compare

First release