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

Incorrect reference for Creating a backoffice API #6728

Closed
russellshome opened this issue Dec 10, 2024 · 5 comments
Closed

Incorrect reference for Creating a backoffice API #6728

russellshome opened this issue Dec 10, 2024 · 5 comments
Labels
category/umbraco-cms review/developer Use this label if an internal developer review is required

Comments

@russellshome
Copy link
Contributor

What type of issue is it? (Choose one - delete the others)

Wrong documentation

What article/section is this about?

https://docs.umbraco.com/umbraco-cms/14.latest/tutorials/creating-a-backoffice-api
https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-backoffice-api

Describe the issue

The documentation says
To create a custom API, you need to create a class that inherits from Umbraco.Cms.Web.BackOffice.Controllers.ManagementApiControllerBase

But Umbraco.Cms.Web.BackOffice no longer exists in Umbraco 14+

For Umbraco 14+ I think the following should be replaced

Umbraco.Cms.Web.BackOffice.Controllers.ManagementApiControllerBase
=>
Umbraco.Cms.Api.Management.Controllers.ManagementApiControllerBase

@sofietoft sofietoft added category/umbraco-cms review/developer Use this label if an internal developer review is required labels Dec 10, 2024
@sofietoft
Copy link
Contributor

Thanks for raising this @russellshome ! 🙌 Much appreciated!

I'll make sure we get this verified so we can update the documentation accordingly!

@sofietoft
Copy link
Contributor

Hi @russellshome !

The changes you're suggestions are indeed correct, and our docs should be updated.
Would you be up for making the change?
Let me know, otherwise I'll make sure we update it as soon as possible.

russellshome added a commit to russellshome/UmbracoDocs that referenced this issue Dec 19, 2024
For Umbraco 14+ I think the following should be replaced

Umbraco.Cms.Web.BackOffice.Controllers.ManagementApiControllerBase
=>
Umbraco.Cms.Api.Management.Controllers.ManagementApiControllerBase
@russellshome
Copy link
Contributor Author

Done #6758

@russellshome
Copy link
Contributor Author

Just a suggestion about the "Edit on GitHub" link on the right of the article. It is dark grey on black rendering it almost invisible to me. This is also a problem for code in the articles. I end up having to highlight the content to get white on dark blue so I can read it comfortably.

You can use https://webaim.org/resources/contrastchecker/ to work out a better colour combination that makes the content easier to read. (ie. passes WCAG AAA)

sofietoft added a commit that referenced this issue Dec 20, 2024
@sofietoft
Copy link
Contributor

Thanks for the suggestions @russellshome !

I'll make sure we look into this in the new year.
I've merged your PR, so will mark this issue as resolve!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
category/umbraco-cms review/developer Use this label if an internal developer review is required
Projects
None yet
Development

No branches or pull requests

2 participants