Orchard Core Headless: APIs to create, update or delete a Content Item instance

[MarGraz]

Hi,

I'm trying to learn more about the APIs available in Orchard Core, especially regarding GraphQL. I'm interested in whether it's possible to create, update, or delete a Content Item instance through APIs.

I've looked at the documentation, but the details on how it works aren't clear to me. For updating and deleting a Content Items instance, do I need to create my own ApiController, or does Orchard Core, with its dynamic types, already provide a way to handle these operations?

Could you suggest how I might create, update, or delete a Page Content Item instance through the API endpoint? Additionally, is there a method to view all available endpoints?

Thank you

[MarGraz]

Looking at the Orchard Core solution, and going deeper into the issues (not the discussions), I found a useful issue here that is similar to my case.

In the end, the module OrchardCore.Contents exposes an ApiController.cs with endpoints to create, update, and delete content items created in the "Admin" backoffice using Postman (and the OpenID Connect module for the authentication).

@Skrypt, I mention you because you also replied to the issue I mentioned before. Can I add information about these endpoints in the documentation? Because I think it's a significant omission.

Is it appropriate to add this information to the Content Types docs?

Thank you

[MarGraz]

@hishamco I tried the "Swagger Module", it's really simple to install and use. I started my project using a "blank site" recipe, so I can only see the "Content" endpoints.

Is there a "User" endpoint?
Because I'm looking for a way to list all the users, but it seems that the "User Module" doesn't have any ApiController to do this. I opened a discussion here.

Thank you

[hishamco]

I prefer to file an issue or open a discussion to OCC repo

[MarGraz]

Yes, I already I opened a discussion here.

[hishamco]

I was referring to Swagger Module :)

[MarGraz]

@hishamco I have opened a new discussion in the OCC repo 😊

[MarGraz]

Using Postman, it's possible to call the ApiController.cs endpoints after configuring the "OpenID Connect" module. I tested this using the "Try Orchard" website. The authentication process is successful, and I receive a valid OAuth 2 token. But, when attempting to use the "Admin" user, which is supposed to have the highest privileges, I cannot perform GET, UPDATE, or DELETE operations, I receive a 401 unauthorized error. Instead, if I grant all privileges to the "anonymous" user role to call the API, and remove the OAuth token, it works 🤔

Could this issue be related to the user not having the permission at line 43? However, my user has the Permissions.AccessContentApi.

This is the part at line 43:

[Route("{contentItemId}"), HttpGet]
       public async Task<IActionResult> Get(string contentItemId)
       {
           if (!await _authorizationService.AuthorizeAsync(User, Permissions.AccessContentApi))
           {
               return this.ChallengeOrForbid("Api");
           }
           
           [...]
           
         }

Any suggestions?

[Piedone]

Also see: https://github.com/Lombiq/Orchard-Core-API-Client.

[hishamco]

Exactly, I forgot to mention it, @Piedone you remind me with another Zolte :)

[Piedone]

There are too many Zoltáns in Lombiq :D.

[hishamco]

BTW Zoltan is used in Arabic as "Sultan" :)

[Piedone]

Yep, that's where it comes from :).

[hishamco]

Could you suggest how I might create, update, or delete a Page Content Item instance through the API endpoint? Additionally, is there a method to view all available endpoints?

Could you try Swagger Module https://github.com/OrchardCoreContrib/OrchardCoreContrib.Modules/blob/main/src/OrchardCoreContrib.Apis.Swagger/README.md

[MarGraz]

@hishamco, oh, that's great 🥳 Who is maintaining the OrchardCoreContrib.Modules? I think it could also be useful to mention it in the documentation.

Please, also see my previous two replies. I think we posted at the same time, and I'm asking about which part of the documentation to update 🙂

[hishamco]

@hishamco, oh, that's great 🥳 Who is maintaining the OrchardCoreContrib.Modules? I think it could also be useful to mention it in the documentation.

It's me for now :) but all the Orchard Core contributors are welcome