docs(api): update api path (#5876)

docs/.gitignore

@@ -10,16 +10,7 @@
 .artifacts
 
 # Generated by docusaurus-plugin-openapi-docs
-docs/apis/auth
+docs/apis/resources
-docs/apis/mgmt
-docs/apis/admin
-docs/apis/system
-docs/apis/user_service
-docs/apis/session_service
-docs/apis/system
-docs/apis/user_service
-docs/apis/session_service
-docs/apis/settings_service
 
 # Misc
 .DS_Store

docs/docs/apis/introduction.mdx

@@ -50,7 +50,7 @@ Endpoint:
 $ZITADEL_DOMAIN/auth/v1/
 
 API Reference:
-[OpenAPI Docs](/apis/auth)
+[OpenAPI Docs](/apis/resources/auth)
 
 </div>
 </Column>
@@ -83,7 +83,7 @@ Endpoint:
 $ZITADEL_DOMAIN/management/v1/
 
 API Reference:
-[OpenAPI Docs](/apis/mgmt)
+[OpenAPI Docs](/apis/resources/mgmt)
 
 </div>
 </Column>
@@ -114,7 +114,7 @@ Endpoint:
 $ZITADEL_DOMAIN/admin/v1/
 
 API Reference:
-[OpenAPI Docs](/apis/admin)
+[OpenAPI Docs](/apis/resources/admin)
 
 </div>
 </Column>
@@ -147,7 +147,7 @@ Endpoint:
 $ZITADEL_DOMAIN/system/v1/
 
 API Reference:
-[OpenAPI Docs](/apis/system)
+[OpenAPI Docs](/apis/resources/system)
 
 </div>
 </Column>

docs/docs/concepts/features/audit-trail.md

@@ -35,7 +35,7 @@ Go to your instance settings and then click on the Tab **Events** to open the Ev
 Since everything that is available in Console can also be called with our APIs, you can access all events and audit data trough our APIs:
 
 - [Event API Guide](/docs/guides/integrate/event-api)
-- [API Documentation](/docs/category/apis/admin/events)
+- [API Documentation](/docs/category/apis/resources/admin/events)
 
 Access to the API is possible with a [Service User](/docs/guides/integrate/serviceusers) account, allowing you to integrate the events with your own business logic.
 

docs/docs/concepts/structure/instance.mdx

@@ -20,7 +20,7 @@ Read more about how to configure your instance in our [instance guide](/guides/m
 
 ZITADEL has the concept of virtual instances.
 When installing ZITADEL from scratch, one instance is always automatically created for you.
-Nevertheless, you can add more virtual instances via the [system API](/apis/system).
+Nevertheless, you can add more virtual instances via the [system API](/apis/resources/system).
 This is useful if you have business customers, which in turn have their business customers with self service and custom domain demands.
 By providing a virtual ZITADEL instances, your customers have all the customization options available in ZITADEL.
 Scaling ZITADEL instances virtually enables you to easily distribute your limited compute resources to all your customers.

docs/docs/guides/integrate/access-zitadel-system-api.md

@@ -145,7 +145,7 @@ You should get a successful response with a `totalResult` number of 1 and the de
 }
 ```
 
-With this token you are allowed to access the whole [ZITADEL System API](/apis/system).
+With this token you are allowed to access the whole [ZITADEL System API](/apis/resources/system).
 
 ## Summary
 

docs/docs/guides/integrate/event-api.md

@@ -11,7 +11,7 @@ You need to give a user the [manager role](https://zitadel.com/docs/guides/manag
 If you like to know more about eventsourcing/eventstore and how this works in ZITADEL, head over to our [concepts](../../concepts/eventstore/overview).
 ## Request Events
 
-Call the [ListEvents](/apis/admin) enpoint in the Administration API to get all the events you need.
+Call the [ListEvents](/apis/resources/admin) enpoint in the Administration API to get all the events you need.
 To further restrict your result you can add the following filters:
 - sequence
 - editor user id
@@ -29,7 +29,7 @@ curl --request POST \
 
 ## Get event types
 
-To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](/apis/admin)
+To be able to filter for the different event types ZITADEL knows, you can request the [EventTypesList](/apis/resources/admin)
 
 ```bash
 curl --request POST \
@@ -65,7 +65,7 @@ The following example shows you the event types for a password check (failed/suc
 
 ## Get aggregate types
 
-To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](/apis/admin)
+To be able to filter for the different aggregate types (resources) ZITADEL knows, you can request the [AggregateTypesList](/apis/resources/admin)
 
 ```bash
 curl --request POST \

docs/docs/guides/manage/user/reg-create-user.md

@@ -6,7 +6,7 @@ The ZITADEL API has different possibilities to create users.
 This can be used, if you are building your own registration page.
 
 Use the following API call to create your users:
-[Create User (Human)](/apis/mgmt/management-service-import-human-user.api.mdx)
+[Create User (Human)](/apis/resources/mgmt/management-service-import-human-user.api.mdx)
 
 ## With Username and Password
 
@@ -31,7 +31,7 @@ If nothing is requested, the type will not be restricted and all possibilities o
 
 If you already have a user in ZITADEL, it is possible to add passwordless later.
 
-[Add Passwordless Registration ](/apis/mgmt)
+[Add Passwordless Registration ](/apis/resources/mgmt)
 
 Send the user_id in the request and you will get a link and an expiration as response.
 You can then customize the link the same as described above in the creation process.
@@ -39,7 +39,7 @@ You can then customize the link the same as described above in the creation proc
 The second possibility is to send the link directly to the user per email.
 Use the following request in that case:
 
-[Send Passwordless Registration ](/apis/mgmt)
+[Send Passwordless Registration ](/apis/resources/mgmt)
 
 ## Verified Email Address
 

docs/docs/guides/migrate/users.md

@@ -7,7 +7,7 @@ Migrating users from an existing system, while minimizing impact on said users,
 
 ## Individual Users
 
-Creating individual users can be done with this endpoint: [ImportHumanUser](/docs/apis/mgmt/management-service-import-human-user).
+Creating individual users can be done with this endpoint: [ImportHumanUser](/docs/apis/resources/mgmt/management-service-import-human-user).
 Please also consult our [guide](/docs/guides/manage/user/reg-create-user) on how to create users.
 
 ```json
@@ -42,7 +42,7 @@ Please also consult our [guide](/docs/guides/manage/user/reg-create-user) on how
 
 ## Bulk import
 
-For bulk import use the [import endpoint](https://zitadel.com/docs/apis/admin/admin-service-import-data) on the admin API:
+For bulk import use the [import endpoint](https://zitadel.com/docs/apis/resources/admin/admin-service-import-data) on the admin API:
 
 ```json
 {
@@ -220,7 +220,7 @@ Use metadata to store additional attributes of the users, such as organizational
 
 :::info
 Metadata must be added to users after the users were created. Currently metadata can't be added during user creation.  
-[API reference: User Metadata](https://zitadel.com/docs/category/apis/mgmt/user-metadata)
+[API reference: User Metadata](https://zitadel.com/docs/category/apis/resources/mgmt/user-metadata)
 :::
 
 Request metadata from the userinfo endpoint by passing the required [reserved scope](/docs/apis/openidoauth/scopes#reserved-scopes) in your auth request.
@@ -232,5 +232,5 @@ You can assign roles from owned or granted projects to a user.
 
 :::info
 Authorizations must be added to users after the users were created. Currently metadata can't be added during user creation.  
-[API reference: User Authorization / Grants](https://zitadel.com/docs/category/apis/auth/user-authorizations-grants)
+[API reference: User Authorization / Grants](https://zitadel.com/docs/category/apis/resources/auth/user-authorizations-grants)
 :::

docs/docs/guides/solution-scenarios/b2c.mdx

@@ -29,7 +29,7 @@ You can read more about how ZITADEL handles usernames [here](../manage/console/o
 ZITADEL gives you a basic storage for users and manages phone and email addresses. It also allows you to store your own application data such as preferences or external identifiers to the metadata of a user.
 
 If you are migrating an existing project and you already have an external identity store you can consider bulk importing your user datasets.
-Read our [Management API definitions](/apis/mgmt) for more info. If the users email is not verified or no password is set, a initialization mail will be send.
+Read our [Management API definitions](/apis/resources/mgmt) for more info. If the users email is not verified or no password is set, a initialization mail will be send.
 
 :::info
 Requests to the management API are rate limited. Read our [Rate limit Policy](../../legal/rate-limit-policy) for more info.

docs/docs/self-hosting/manage/quotas.md

@@ -6,7 +6,7 @@ Quotas is an enterprise feature that is relevant if you want to host ZITADEL as
 It enables you to limit usage and/or register webhooks that trigger on configurable usage levels for certain units.
 For example, you might want to report usage to an external billing tool and notify users when 80 percent of a quota is exhausted.
 Quotas are currently supported [for the instance level only](/concepts/structure/instance).
-Please refer to the [system API docs](/apis/system) for detailed explanations about how to use the quotas feature.
+Please refer to the [system API docs](/apis/resources/system) for detailed explanations about how to use the quotas feature.
 
 ZITADEL supports limiting authenticated requests and action run seconds
 

docs/docusaurus.config.js

@@ -234,49 +234,49 @@ module.exports = {
         config: {
           auth: {
             specPath: ".artifacts/openapi/zitadel/auth.swagger.json",
-            outputDir: "docs/apis/auth",
+            outputDir: "docs/apis/resources/auth",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           mgmt: {
             specPath: ".artifacts/openapi/zitadel/management.swagger.json",
-            outputDir: "docs/apis/mgmt",
+            outputDir: "docs/apis/resources/mgmt",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           admin: {
             specPath: ".artifacts/openapi/zitadel/admin.swagger.json",
-            outputDir: "docs/apis/admin",
+            outputDir: "docs/apis/resources/admin",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           system: {
             specPath: ".artifacts/openapi/zitadel/system.swagger.json",
-            outputDir: "docs/apis/system",
+            outputDir: "docs/apis/resources/system",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           user: {
             specPath: ".artifacts/openapi/zitadel/user/v2alpha/user_service.swagger.json",
-            outputDir: "docs/apis/user_service",
+            outputDir: "docs/apis/resources/user_service",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           session: {
             specPath: ".artifacts/openapi/zitadel/session/v2alpha/session_service.swagger.json",
-            outputDir: "docs/apis/session_service",
+            outputDir: "docs/apis/resources/session_service",
             sidebarOptions: {
               groupPathsBy: "tag",
             },
           },
           settings: {
             specPath: ".artifacts/openapi/zitadel/settings/v2alpha/settings_service.swagger.json",
-            outputDir: "docs/apis/settings_service",
+            outputDir: "docs/apis/resources/settings_service",
             sidebarOptions: {
               groupPathsBy: "tag",
             },

docs/sidebars.js

@@ -353,12 +353,12 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "Auth API",
-            slug: "/apis/auth",
+            slug: "/apis/resources/auth",
             description:
               "The authentication API (aka Auth API) is used for all operations on the currently logged in user. The user id is taken from the sub claim in the token.",
 
           },
-          items: require("./docs/apis/auth/sidebar.js"),
+          items: require("./docs/apis/resources/auth/sidebar.js"),
         },
         {
           type: "category",
@@ -366,11 +366,11 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "Management API",
-            slug: "/apis/mgmt",
+            slug: "/apis/resources/mgmt",
             description:
               "The management API is as the name states the interface where systems can mutate IAM objects like, organizations, projects, clients, users and so on if they have the necessary access rights. To identify the current organization you can send a header x-zitadel-orgid or if no header is set, the organization of the authenticated user is set.",
           },
-          items: require("./docs/apis/mgmt/sidebar.js"),
+          items: require("./docs/apis/resources/mgmt/sidebar.js"),
         },
         {
           type: "category",
@@ -378,11 +378,11 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "Admin API",
-            slug: "/apis/admin",
+            slug: "/apis/resources/admin",
             description:
               "This API is intended to configure and manage one ZITADEL instance itself.",
           },
-          items: require("./docs/apis/admin/sidebar.js"),
+          items: require("./docs/apis/resources/admin/sidebar.js"),
         },
         {
           type: "category",
@@ -390,13 +390,13 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "System API",
-            slug: "/apis/system",
+            slug: "/apis/resources/system",
             description:
               "This API is intended to manage the different ZITADEL instances within the system.\n" +
               "\n" +
               "Checkout the guide how to access the ZITADEL System API.",
           },
-          items: require("./docs/apis/system/sidebar.js"),
+          items: require("./docs/apis/resources/system/sidebar.js"),
         },
         {
           type: "category",
@@ -404,13 +404,13 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "User Service API (Alpha)",
-            slug: "/apis/user_service",
+            slug: "/apis/resources/user_service",
             description:
               "This API is intended to manage users in a ZITADEL instance.\n"+
               "\n"+
               "This project is in alpha state. It can AND will continue breaking until the services provide the same functionality as the current login.",
           },
-          items: require("./docs/apis/user_service/sidebar.js"),
+          items: require("./docs/apis/resources/user_service/sidebar.js"),
         },
         {
           type: "category",
@@ -418,13 +418,13 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "Session Service API (Alpha)",
-            slug: "/apis/session_service",
+            slug: "/apis/resources/session_service",
             description:
               "This API is intended to manage sessions in a ZITADEL instance.\n"+
               "\n"+
               "This project is in alpha state. It can AND will continue breaking until the services provide the same functionality as the current login.",
           },
-          items: require("./docs/apis/session_service/sidebar.js"),
+          items: require("./docs/apis/resources/session_service/sidebar.js"),
         },
         {
           type: "category",
@@ -432,13 +432,13 @@ module.exports = {
           link: {
             type: "generated-index",
             title: "Settings Service API (Alpha)",
-            slug: "/apis/settings_service",
+            slug: "/apis/resources/settings_service",
             description:
               "This API is intended to manage settings in a ZITADEL instance.\n"+
               "\n"+
               "This project is in alpha state. It can AND will continue breaking until the services provide the same functionality as the current login.",
           },
-          items: require("./docs/apis/settings_service/sidebar.js"),
+          items: require("./docs/apis/resources/settings_service/sidebar.js"),
         },
         {
           type: "category",

docs/src/pages/index.js

@@ -154,19 +154,19 @@ const features = [
       <div className={styles.apilinks}>
         <ListWrapper>
           <ListElement
-            link="/docs/apis/auth/authentication-api-aka-auth"
+            link="/docs/apis/resources/auth/authentication-api-aka-auth"
             type={ICONTYPE.APIS}
             title="Authenticated User"
             description="All operations on the currently authenticated user."
           />
           <ListElement
-            link="/docs/apis/mgmt/management-api"
+            link="/docs/apis/resources/mgmt/management-api"
             type={ICONTYPE.APIS}
             title="Organization Objects"
             description="Mutate IAM objects like organizations, projects, clients, users etc."
           />
           <ListElement
-            link="/docs/apis/admin/administration-api-aka-admin"
+            link="/docs/apis/resources/admin/administration-api-aka-admin"
             type={ICONTYPE.APIS}
             title="Instance Objects"
             description="Configure and manage the IAM instance."