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. [Database &amp; ORM](/categories/database)
4. /
5. jeffreyvanhees/scramble-model-states

ActiveLibrary[Database &amp; ORM](/categories/database)

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 today

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.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODE1MzY5OTQsIm5iZiI6MTc4MTUzNjY5NCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU3Ny01NGMyN2RiNS01NGVmLTRmMDMtYTc5ZC1hMDg3ODg0MjU3MjUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDYxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA2MTVUMTUxODE0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZWYxMGJlNmMxOTQ2ZjExNDIyYzYyYzJiNDA3N2NmYjNhYzk0OWJmMGUzYzkxYWQ0ZDVmNDUxYTI0Yjg4YjZiYyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmcmVzcG9uc2UtY29udGVudC10eXBlPWltYWdlJTJGcG5nIn0.-yM9oSXBi0Nbp4euUHYUq-U-PvaLP9LWjfxusXFsQRg)](https://private-user-images.githubusercontent.com/8754630/354187577-54c27db5-54ef-4f03-a79d-a08788425725.png?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3ODE1MzY5OTQsIm5iZiI6MTc4MTUzNjY5NCwicGF0aCI6Ii84NzU0NjMwLzM1NDE4NzU3Ny01NGMyN2RiNS01NGVmLTRmMDMtYTc5ZC1hMDg3ODg0MjU3MjUucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI2MDYxNSUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNjA2MTVUMTUxODE0WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZWYxMGJlNmMxOTQ2ZjExNDIyYzYyYzJiNDA3N2NmYjNhYzk0OWJmMGUzYzkxYWQ0ZDVmNDUxYTI0Yjg4YjZiYyZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmcmVzcG9uc2UtY29udGVudC10eXBlPWltYWdlJTJGcG5nIn0.-yM9oSXBi0Nbp4euUHYUq-U-PvaLP9LWjfxusXFsQRg)

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

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

[](#installation)

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

Usage
-----

[](#usage)

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

```
