with_slug missing in types in Management API (also others params missing)

[marckraw]

---

Expected Behavior

Documentation for management api and delivery api should be in sync with actual storyblok-js-client and its typescript types. If it's not, its hard to understand what is the current API.

Current Behavior

https://www.storyblok.com/docs/api/management#core-resources/stories/retrieve-multiple-stories

Documentation said that i can use with_slug param, but it looks like types are not aware of that:

Other params not existing in type:

• text_search
• contain_component
• pinned
• by_ids
• folder_only
• story_only
• with_parent
• with_slug
• search
• in_release
• is_published

It looks like, it is just type problem, becasue when I do it with @ts-ignore:

const storiesWithoutContent: any = await sbApi
        .get(`spaces/${spaceId}/stories/`, {
            per_page: 100,
            // @ts-ignore
            with_slug: 'folder/story-inside-folder'
        })
        .then((res: any) => res.data.stories)
        .catch((err: any) => console.error(err));

than it returns filtered result.

Steps to Reproduce

Just create a repo with storyblok-js-client@5.8.0, use typescript, and try to make request with with_slug param.

[marckraw]

well, didn't realize that i've created duplicated of this https://github.com/storyblok/storyblok-js-client/issues/477 🤦🏻 documented others missing types, so I guess will not close it yet :P

[marckraw]

Actually not a duplicate, but also about types, but this time the missing types for params not a result.

[thiagosaife]

@marckraw Hello, sir. We have an open pull request ready to be QA'd that solves this issues. I'll keep you posted here. Thanks for the heads up.

[javierdebug]

Hey, in the end, this wasn't resolved. I had issues with that; the solution was to use .js instead of .ts. Are there any updates about it?

[thiagosaife]

@javierdebug Not yet, sir. We'll close this issue when done. I'll keep you posted here.

[rasmusbe]

Any news about getting correct types for the Management API Client?

[thiagosaife]

@rasmusbe Yes, pull request is opened extending all these missing types. Keep you posted.

[thiagosaife]

@rasmusbe Please, try out the latest version. I'll close this thread, but feel free to re open it if this wasn't solved.

[rasmusbe]

I need to try it more next week when I'm back at work I tried it quickly and it seems like the put and post input parameters and response is still wrong.

[rasmusbe]

And I dont seems to be able to reopen the issue

[thiagosaife]

@rasmusbe That's weird. post and put they have ISbStoriesParams as their interface to params, which was extended with the missing types. Can you please share a test case when you have the time? Please do not share any sensitive data.

[rasmusbe]

I'm sorry for the delay. i haven't had the time to do a test case but here's some stuff I found:

• Slug is wrongly required in the types for post/put when is_startpage is true.
• parent_id is number when reading (GET and POST/PUT responses) but a string on write.
• published is missing in the types for translated_slugs (used when the setting publish per language is active in the space)

[alvarosabu]

Hi @marckraw @rasmusbe @javierdebug I just found this issue while triaging and cleaning out issues

I would assume this is still relevant, so I will add it to my priorities.

Thanks a lot, everyone for your patience 🙏🏻