PHPackages                             jeffreyvanhees/scramble-model-states - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. jeffreyvanhees/scramble-model-states

ActiveLibrary

jeffreyvanhees/scramble-model-states
====================================

Add Spatie's Model States package support for Scramble (Laravel)

v0.0.2(1y ago)010MITPHPPHP ^8.0

Since Aug 1Pushed 1y ago1 watchersCompare

[ Source](https://github.com/jeffreyvanhees/scramble-model-states)[ Packagist](https://packagist.org/packages/jeffreyvanhees/scramble-model-states)[ RSS](/packages/jeffreyvanhees-scramble-model-states/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (2)Dependencies (2)Versions (3)Used By (0)

Spatie Model States support for Scramble (Laravel OpenAPI (Swagger) Documentation Generator)
============================================================================================

[](#spatie-model-states-support-for-scramble-laravel-openapi-swagger-documentation-generator)

This package adds support for [laravel-model-states](https://github.com/spatie/laravel-model-states) to [dedoc/scramble](https://github.com/dedoc/scramble) by providing an extension. After installing the extension, all possible states are added as possible values to the response body, like Scramble does with an enum.

[![Screenshot_2024-08-01_at_11 02 47](https://private-user-images.githubusercontent.com/8754630/354187577-54c27db5-54ef-4f03-a79d-a08788425725.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUyMDAyNjgsIm5iZiI6MTc3NTE5OTk2OCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU3Ny01NGMyN2RiNS01NGVmLTRmMDMtYTc5ZC1hMDg3ODg0MjU3MjUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDNUMDcwNjA4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MGQ0YjEzZjIzY2U5YzE4ZjY4MzY3MmU3NTY1N2ViYTllODFiZDUzMTViOWQyN2ZhYTJiMDMxZjc3YjQ4YzYwYiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.1PCo-PufthtY_wIQUHPzq1R1xI3jrx9EzTmXG3fULX0)](https://private-user-images.githubusercontent.com/8754630/354187577-54c27db5-54ef-4f03-a79d-a08788425725.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUyMDAyNjgsIm5iZiI6MTc3NTE5OTk2OCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU3Ny01NGMyN2RiNS01NGVmLTRmMDMtYTc5ZC1hMDg3ODg0MjU3MjUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDNUMDcwNjA4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9MGQ0YjEzZjIzY2U5YzE4ZjY4MzY3MmU3NTY1N2ViYTllODFiZDUzMTViOWQyN2ZhYTJiMDMxZjc3YjQ4YzYwYiZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.1PCo-PufthtY_wIQUHPzq1R1xI3jrx9EzTmXG3fULX0)

[![Screenshot_2024-08-01_at_11 02 20](https://private-user-images.githubusercontent.com/8754630/354187597-c8126ff7-8fab-43bd-9e59-cb4a6ee17d3a.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUyMDAyNjgsIm5iZiI6MTc3NTE5OTk2OCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU5Ny1jODEyNmZmNy04ZmFiLTQzYmQtOWU1OS1jYjRhNmVlMTdkM2EucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDNUMDcwNjA4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9M2ZlMjk3N2M3NzcxZTdmMGVkZDY2NTNiOWFjMzRlODEwMjZlN2ViYzljZGQ0NTliYzllZjVlNTgxZDI5MzkzYyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.QN1AD3dJ09E71KW8ZypuCDYCmAWdyHeLN6v8PPM8Ui8)](https://private-user-images.githubusercontent.com/8754630/354187597-c8126ff7-8fab-43bd-9e59-cb4a6ee17d3a.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3NzUyMDAyNjgsIm5iZiI6MTc3NTE5OTk2OCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU5Ny1jODEyNmZmNy04ZmFiLTQzYmQtOWU1OS1jYjRhNmVlMTdkM2EucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDQwMyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA0MDNUMDcwNjA4WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9M2ZlMjk3N2M3NzcxZTdmMGVkZDY2NTNiOWFjMzRlODEwMjZlN2ViYzljZGQ0NTliYzllZjVlNTgxZDI5MzkzYyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QifQ.QN1AD3dJ09E71KW8ZypuCDYCmAWdyHeLN6v8PPM8Ui8)

Installation
------------

[](#installation)

Install the extention with composer via `composer require jeffreyvanhees/scramble-model-states`

Usage
-----

[](#usage)

Add the extenstion to `config/scramble.php`:

```