Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Subgroups and/or endpoints sorting not works #947

Closed
1 task done
heribertolord96 opened this issue Feb 14, 2025 · 4 comments
Closed
1 task done

Subgroups and/or endpoints sorting not works #947

heribertolord96 opened this issue Feb 14, 2025 · 4 comments

Comments

@heribertolord96
Copy link

Scribe version

4.40

Your question

Based on https://scribe.knuckles.wtf/blog/laravel-v4 i try to create a docs grouping endpoints as subgroups of a group , or almost sort the endpoints, with theme config

    'type' => 'external_static', 'theme' => 'scalar',

Elsewhere i tried each theme .
In the endpoint function i add

 /**
     * 
     * @group whatsapp
     * @subgroup messages
     * @subgroupDescription  whatsapp messages
     * Summary of index
    */
    public function index()

And in config file

 'order' => [
  'whatsapp' => [
                'messages',
        ]
    ]

Subgroups nesting not works .
endpoint sorting not works also :

'whatsapp' => [
 'GET /whatsapp/messages',
 'POST /whatsapp/messages',

I tried some distinct modes . but nothing change .

Docs

@shalvah
Copy link
Contributor

shalvah commented Feb 16, 2025

To confirm, you have the order key INSIDE the groups key, right?

'groups' => [
 'order' => [
  'whatsapp' => [
                'messages',
        ]
    ]
]

Please share what the output looks like in both cases.

@shalvah
Copy link
Contributor

shalvah commented Feb 16, 2025

Also note that if you're using external as your type, sorting does not work.

(Pre-emptively closing this. Let me know if it's still an issue.)

@shalvah shalvah closed this as completed Feb 16, 2025
@heribertolord96
Copy link
Author

heribertolord96 commented Feb 17, 2025

subgrouping finally was works using type static & theme default

'type' => 'static',
 'theme' => 'default',
  'groups' => [
     'order' => [
        'facebook'=>[
                    'pages'
                  ],
     ],
]
 ... 

Just i need like this
Image

@shalvah
Copy link
Contributor

shalvah commented Feb 18, 2025

(I recommend using type laravel, btw. It makes it easier to host your docs in production, since they will be served by your already-existing Laravel app.)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants