Implemented: apis should use plurals #183

plainblack · Jan 14, 2025 · 9308027 · 9308027
1 parent ade6ccf
commit 9308027
Show file tree

Hide file tree

Showing 94 changed files with 203 additions and 178 deletions.
diff --git a/app/components/ving/Dropzone.vue b/app/components/ving/Dropzone.vue
@@ -16,7 +16,7 @@ import '../node_modules/dropzone/dist/dropzone.css'
 Dropzone.autoDiscover = false;
 
 const getSignedURL = async (file) => {
-    const response = await useRest(`/api/${useRestVersion()}/s3file?includeMeta=true`, {
+    const response = await useRest(`/api/${useRestVersion()}/s3files?includeMeta=true`, {
         method: 'POST', body: {
             contentType: file.type,
             filename: file.name,

diff --git a/app/composables/ving/useAdminLinks.mjs b/app/composables/ving/useAdminLinks.mjs
@@ -8,9 +8,9 @@
 export default () => {
     const links = computed(() => {
         const out = [
-            { label: 'Cron Jobs', to: '/cronjob', icon: 'ph:clock' },
+            { label: 'Cron Jobs', to: '/cronjobs', icon: 'ph:clock' },
             { label: 'System Wide Alert', to: '/system-wide-alert', icon: 'ph:megaphone' },
-            { label: 'Users', to: '/user/admin', icon: 'ph:users' },
+            { label: 'Users', to: '/users/admin', icon: 'ph:users' },
         ];
         return out;
     });

diff --git a/app/composables/ving/useCurrentUser.mjs b/app/composables/ving/useCurrentUser.mjs
@@ -3,12 +3,12 @@ import { isUndefined } from '#ving/utils/identify.mjs';
 
 export const useCurrentUser = () => useVingRecord({
     id: 'currentUser',
-    fetchApi: `/api/${useRestVersion()}/user/whoami`,
-    createApi: `/api/${useRestVersion()}/user`,
+    fetchApi: `/api/${useRestVersion()}/users/whoami`,
+    createApi: `/api/${useRestVersion()}/users`,
     query: { includeOptions: true, includeMeta: true, includeLinks: true },
     extendedActions: {
         async login(login, password) {
-            const response = await useRest(`/api/${useRestVersion()}/session`, {
+            const response = await useRest(`/api/${useRestVersion()}/sessions`, {
                 method: 'post',
                 body: {
                     login,
@@ -24,7 +24,7 @@ export const useCurrentUser = () => useVingRecord({
         },
 
         async logout() {
-            const response = await useRest(`/api/${useRestVersion()}/session`, {
+            const response = await useRest(`/api/${useRestVersion()}/sessions`, {
                 method: 'delete',
             });
             this.setState({});

diff --git a/app/composables/ving/useMessageBus.mjs b/app/composables/ving/useMessageBus.mjs
@@ -29,7 +29,7 @@ export default async function useMessageBus() {
     const reconnect = () => setTimeout(tryToSetup, wait);
 
     const setupBusHandler = () => {
-        bus = new EventSource(`/api/${useRestVersion()}/user/messagebus`);
+        bus = new EventSource(`/api/${useRestVersion()}/users/messagebus`);
         bus.onmessage = (event) => {
             const message = JSON.parse(event.data);
             switch (message.type) {

diff --git a/app/composables/ving/useRest.mjs b/app/composables/ving/useRest.mjs
@@ -14,7 +14,7 @@
  *
  * The `error` is `null` unless there is an error, and the `data` contains an object response from the endpoint.
  * @example
- * const response = await useRest('/api/v1/user/xxx')
+ * const response = await useRest('/api/v1/users/xxx')
  */
 export default async function (url, behavior = {}) {
     const notify = useNotify();

diff --git a/app/composables/ving/useUserSettingsButtons.mjs b/app/composables/ving/useUserSettingsButtons.mjs
@@ -9,7 +9,7 @@ export default () => {
     const currentUser = useCurrentUser();
     const buttons = computed(() => {
         const out = [
-            { label: 'Sign Out', to: '/user/logout', icon: 'ph:door', severity: 'primary' },
+            { label: 'Sign Out', to: '/users/logout', icon: 'ph:door', severity: 'primary' },
         ];
         if (currentUser.props?.admin)
             out.push({ label: 'Admin', to: '/admin', icon: 'ph:users', severity: 'secondary' });

diff --git a/app/composables/ving/useUserSettingsLinks.mjs b/app/composables/ving/useUserSettingsLinks.mjs
@@ -9,12 +9,12 @@ export default () => {
     const currentUser = useCurrentUser();
     const links = computed(() => {
         const out = [
-            { label: 'Profile', to: '/user/settings', icon: 'ph:user' },
-            { label: 'Account', to: '/user/settings/account', icon: 'ph:key' },
-            { label: 'Preferences', to: '/user/settings/preferences', icon: 'ph:sliders' },
+            { label: 'Profile', to: '/users/settings', icon: 'ph:user' },
+            { label: 'Account', to: '/users/settings/account', icon: 'ph:key' },
+            { label: 'Preferences', to: '/users/settings/preferences', icon: 'ph:sliders' },
         ];
         if (currentUser?.props?.developer == true)
-            out.push({ label: 'API Keys', to: '/user/settings/apikeys', icon: 'ph:lock' });
+            out.push({ label: 'API Keys', to: '/users/settings/apikeys', icon: 'ph:lock' });
         return out;
     });
     return links;

diff --git a/app/composables/ving/useVingKind.mjs b/app/composables/ving/useVingKind.mjs
@@ -145,7 +145,7 @@ class VingKind {
      * @param {object} options Modify the behavior of this call.
      * @returns {Promise<object>} A promise containing the response to the call.
      * @example
-     * const result = Users.call('post', '/user/xxx/send-reset-password', {os:'Windows'});
+     * const result = Users.call('post', '/users/xxx/send-reset-password', {os:'Windows'});
      */
     async call(method, url, query = {}, options = {}) {
         const response = await useRest(url, {

diff --git a/app/composables/ving/useVingRecord.mjs b/app/composables/ving/useVingRecord.mjs
@@ -32,8 +32,8 @@ import { isObject, isUndefined } from '#ving/utils/identify.mjs';
  * @example
  * const user = useVingRecord({
  *  id : 'xxx',
- *  fetchApi: '/api/v1/user/xxx',
- *  createApi: '/api/v1/user',
+ *  fetchApi: '/api/v1/users/xxx',
+ *  createApi: '/api/v1/users',
  *  query : { includeMeta : true },
  * });
  * await user.fetch();

diff --git a/app/layouts/default.vue b/app/layouts/default.vue
@@ -28,7 +28,7 @@
                         <InputText placeholder="Search (non-functional)" type="text" class="w-8rem sm:w-auto" />
                     </InputGroup>
                     <SplitButton v-if="currentUser.props?.id" :model="userMenu" text>
-                        <NuxtLink to="/user/settings" class="flex items-center">
+                        <NuxtLink to="/users/settings" class="flex items-center">
                             <Avatar :image="currentUser.links?.avatarImage?.href" alt="user avatar" shape="circle" />
                             <span class="ml-2">
                                 {{ currentUser.meta?.displayName }}
@@ -41,7 +41,7 @@
                             </NuxtLink>
                         </template>
                     </SplitButton>
-                    <NuxtLink v-else to="/user/login" class="flex p-3 items-center text-nowrap">
+                    <NuxtLink v-else to="/users/login" class="flex p-3 items-center text-nowrap">
                         <Icon name="fa6-solid:door-open" class="mr-2" />
                         Sign In
                     </NuxtLink>
@@ -82,8 +82,8 @@ const topNav = [
 
 const userMenu = computed(() => {
     const out = [
-        { label: 'Settings', to: '/user/settings', icon: 'fa6-solid:sliders' },
-        { label: 'Sign Out', to: '/user/logout', icon: 'fa6-solid:door-closed' },
+        { label: 'Settings', to: '/users/settings', icon: 'fa6-solid:sliders' },
+        { label: 'Sign Out', to: '/users/logout', icon: 'fa6-solid:door-closed' },
     ];
     if (currentUser.props.admin)
         out.unshift({ label: 'Admin', to: '/admin', icon: 'prime:user-plus' });

diff --git a/app/middleware/auth.mjs b/app/middleware/auth.mjs
@@ -2,11 +2,11 @@ export default defineNuxtRouteMiddleware(async (to, from) => {
     const currentUser = useCurrentUser();
     const isAuthenticated = await currentUser.isAuthenticated();
     if (!isAuthenticated) {
-        return await navigateTo(`/user/login?redirectAfter=${to.fullPath}`);
+        return await navigateTo(`/users/login?redirectAfter=${to.fullPath}`);
     }
     else if (!currentUser.props?.verifiedEmail) {
-        if (to.fullPath != '/user/logout') {
-            return await navigateTo(`/user/must-verify-email?redirectAfter=${to.fullPath}`);
+        if (to.fullPath != '/users/logout') {
+            return await navigateTo(`/users/must-verify-email?redirectAfter=${to.fullPath}`);
         }
     }
 });
diff --git a/app/pages/admin.vue b/app/pages/admin.vue
@@ -2,5 +2,5 @@
 
 </template>
 <script setup>
-navigateTo('/user/admin');
+navigateTo('/users/admin');
 </script>
diff --git a/app/pages/cronjob/[id]/edit.vue → app/pages/cronjobs/[id]/edit.vue b/app/pages/cronjob/[id]/edit.vue → app/pages/cronjobs/[id]/edit.vue
@@ -42,8 +42,8 @@ const notify = useNotify();
 const id = route.params.id.toString();
 const cronjob = useVingRecord({
     id,
-    fetchApi: `/api/${useRestVersion()}/cronjob/${id}`,
-    createApi: `/api/${useRestVersion()}/cronjob`,
+    fetchApi: `/api/${useRestVersion()}/cronjobs/${id}`,
+    createApi: `/api/${useRestVersion()}/cronjobs`,
     query: { includeMeta: true, includeOptions: true  },
     onUpdate() {
         notify.success('Updated Cron Job.');

diff --git a/app/pages/cronjob/index.vue → app/pages/cronjobs/index.vue b/app/pages/cronjob/index.vue → app/pages/cronjobs/index.vue
@@ -48,10 +48,13 @@ definePageMeta({
     middleware: ['auth', 'admin']
 });
 const cronjobs = useVingKind({
-    listApi: `/api/${useRestVersion()}/cronjob`,
-    createApi: `/api/${useRestVersion()}/cronjob`,
+    listApi: `/api/${useRestVersion()}/cronjobs`,
+    createApi: `/api/${useRestVersion()}/cronjobs`,
     query: { includeMeta: true, sortBy: 'schedule', sortOrder: 'asc'  },
     newDefaults: { schedule: '* * * * *', handler: 'Test', enabled: true },
+    onCreate(props) {
+        navigateTo(props.links.edit.href)
+    },
 });
 await Promise.all([
     cronjobs.search(),

diff --git a/app/pages/user/[id]/profile.vue → app/pages/users/[id]/profile.vue b/app/pages/user/[id]/profile.vue → app/pages/users/[id]/profile.vue
@@ -33,8 +33,8 @@
 const route = useRoute();
 
 const user = useVingRecord({
-    fetchApi: `/api/${useRestVersion()}/user/${route.params.id}`,
-    createApi: `/api/${useRestVersion()}/user`,
+    fetchApi: `/api/${useRestVersion()}/users/${route.params.id}`,
+    createApi: `/api/${useRestVersion()}/users`,
     query: { includeMeta: true, includeOptions: true },
 });
 await user.fetch()

diff --git a/app/pages/user/[id]/reset-password.vue → app/pages/users/[id]/reset-password.vue b/app/pages/user/[id]/reset-password.vue → app/pages/users/[id]/reset-password.vue
@@ -5,7 +5,7 @@
             <img :src="config.public.site.logoUrl" :alt="config.public.site.name" height="50" class="mb-3">
             <h1 class="text-900 text-3xl font-medium mb-3 mt-0">Reset Password</h1>
             <span class="text-600 font-medium line-height-3">Remember your account?</span>
-            <NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
+            <NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
             </NuxtLink>
         </div>
         <PanelZone>
@@ -41,14 +41,14 @@ const config = useRuntimeConfig();
 const notify = useNotify();
 async function resetPassword() {
     notify.info('Please wait while we reset your password...');
-    const response = await useRest(`/api/${useRestVersion()}/user/${route.params.id}/reset-password`, {
+    const response = await useRest(`/api/${useRestVersion()}/users/${route.params.id}/reset-password`, {
         method: 'post',
         query: { includeOptions: true },
         body: { code: newPassword.code, password: newPassword.password },
     });
     if (!response.error) {
         notify.success('Password changed.');
-        await navigateTo('/user/login');
+        await navigateTo('/users/login');
     }
 }
 </script>
diff --git a/app/pages/user/admin/[id].vue → app/pages/users/admin/[id].vue b/app/pages/user/admin/[id].vue → app/pages/users/admin/[id].vue
@@ -88,8 +88,8 @@ const notify = useNotify();
 const id = route.params.id.toString();
 const user = useVingRecord({
     id,
-    fetchApi: `/api/${useRestVersion()}/user/${id}`,
-    createApi: `/api/${useRestVersion()}/user`,
+    fetchApi: `/api/${useRestVersion()}/users/${id}`,
+    createApi: `/api/${useRestVersion()}/users`,
     query: { includeMeta: true, includeOptions: true },
     onUpdate() {
         notify.success('Updated user.');

diff --git a/app/pages/user/admin/index.vue → app/pages/users/admin/index.vue b/app/pages/user/admin/index.vue → app/pages/users/admin/index.vue
@@ -80,10 +80,13 @@ definePageMeta({
 });
 
 const users = useVingKind({
-    listApi: `/api/${useRestVersion()}/user`,
-    createApi: `/api/${useRestVersion()}/user`,
+    listApi: `/api/${useRestVersion()}/users`,
+    createApi: `/api/${useRestVersion()}/users`,
     query: { includeMeta: true, sortBy: 'username', sortOrder: 'asc' },
     newDefaults: { username: '', realName: '', email: '' },
+    onCreate(props) {
+        navigateTo(props.links.edit.href)
+    },
 });
 await users.search();
 

diff --git a/app/pages/user/create.vue → app/pages/users/create.vue b/app/pages/user/create.vue → app/pages/users/create.vue
@@ -5,7 +5,7 @@
             <img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
             <h1 class="text-900 text-3xl font-medium mb-3 mt-0">Create an Account</h1>
             <span class="text-600 font-medium line-height-3">Already have an account?</span>
-            <NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
+            <NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
             </NuxtLink>
         </div>
         <PanelZone>

diff --git a/app/pages/user/login.vue → app/pages/users/login.vue b/app/pages/user/login.vue → app/pages/users/login.vue
@@ -5,7 +5,7 @@
             <img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
             <h1 class="text-900 text-3xl font-medium mb-3 mt-0">Welcome Back</h1>
             <span class="text-600 font-medium line-height-3">Don't have an account?</span>
-            <NuxtLink to="/user/create" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Create one today!
+            <NuxtLink to="/users/create" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Create one today!
             </NuxtLink>
         </div>
         <PanelZone>
@@ -22,7 +22,7 @@
 
             <div class="mt-3">
                 <span class="text-600 font-medium line-height-3">Forgot your password?</span>
-                <NuxtLink to="/user/reset-password" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Reset
+                <NuxtLink to="/users/reset-password" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Reset
                     your
                     password.
                 </NuxtLink>

diff --git a/app/pages/user/logout.vue → app/pages/users/logout.vue b/app/pages/user/logout.vue → app/pages/users/logout.vue
diff --git a/app/pages/user/must-verify-email.vue → app/pages/users/must-verify-email.vue b/app/pages/user/must-verify-email.vue → app/pages/users/must-verify-email.vue
diff --git a/app/pages/user/reset-password.vue → app/pages/users/reset-password.vue b/app/pages/user/reset-password.vue → app/pages/users/reset-password.vue
@@ -5,7 +5,7 @@
             <img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
             <h1 class="text-900 text-3xl font-medium mb-3 mt-0">Send Password Reset</h1>
             <span class="text-600 font-medium line-height-3">Remember your account?</span>
-            <NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
+            <NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
             </NuxtLink>
         </div>
         <PanelZone info="Where should we send the password reset email?">
@@ -33,7 +33,7 @@ const email = ref('')
 const notify = useNotify();
 async function sendPasswordReset() {
     const parser = new ua(navigator.userAgent);
-    const response = await useRest(`/api/${useRestVersion()}/user/send-password-reset`, {
+    const response = await useRest(`/api/${useRestVersion()}/users/send-password-reset`, {
         method: 'post',
         query: { includeOptions: true },
         body: { browser: parser.getBrowser().name, os: parser.getOS().name, email: email.value }

diff --git a/app/pages/user/settings/account.vue → app/pages/users/settings/account.vue b/app/pages/user/settings/account.vue → app/pages/users/settings/account.vue
diff --git a/app/pages/user/settings/apikeys.vue → app/pages/users/settings/apikeys.vue b/app/pages/user/settings/apikeys.vue → app/pages/users/settings/apikeys.vue
@@ -92,7 +92,7 @@ const links = useUserSettingsLinks();
 const buttons = useUserSettingsButtons();
 const apikeys = useVingKind({
     listApi: currentUser.links?.apikeys.href,
-    createApi: `/api/${useRestVersion()}/apikey`,
+    createApi: `/api/${useRestVersion()}/apikeys`,
     query: { includeMeta: true, sortBy: 'name', sortOrder: 'asc' },
     newDefaults: { name: 'My New API Key', reason: '', url: 'http://', userId: currentUser.props?.id },
 });

diff --git a/app/pages/user/settings/index.vue → app/pages/users/settings/index.vue b/app/pages/user/settings/index.vue → app/pages/users/settings/index.vue
@@ -28,7 +28,7 @@
 
                 <FormInput type="markdown" @change="currentUser.save('bio')" label="Bio"  v-model="currentUser.props.bio" name="bio" class="mb-4"  />
 
-                <NuxtLink :to="'/user/' + currentUser.props.id + '/profile'">
+                <NuxtLink :to="currentUser.links.profile.href">
                     View your profile as others see it
                 </NuxtLink>
             </PanelZone>

diff --git a/app/pages/user/settings/preferences.vue → app/pages/users/settings/preferences.vue b/app/pages/user/settings/preferences.vue → app/pages/users/settings/preferences.vue
diff --git a/app/pages/user/verify-email.vue → app/pages/users/verify-email.vue b/app/pages/user/verify-email.vue → app/pages/users/verify-email.vue
@@ -29,7 +29,7 @@ if (await currentUser.isAuthenticated()) {
     }
 }
 else {
-    await navigateTo('/user/login')
+    await navigateTo('/users/login')
 }
 
 </script>
diff --git a/server/api/v1/apikey/[id]/index.delete.mjs → server/api/v1/apikeys/[id]/index.delete.mjs b/server/api/v1/apikey/[id]/index.delete.mjs → server/api/v1/apikeys/[id]/index.delete.mjs
diff --git a/server/api/v1/apikey/[id]/index.get.mjs → server/api/v1/apikeys/[id]/index.get.mjs b/server/api/v1/apikey/[id]/index.get.mjs → server/api/v1/apikeys/[id]/index.get.mjs
diff --git a/server/api/v1/apikey/[id]/index.put.mjs → server/api/v1/apikeys/[id]/index.put.mjs b/server/api/v1/apikey/[id]/index.put.mjs → server/api/v1/apikeys/[id]/index.put.mjs
diff --git a/server/api/v1/apikey/[id]/user.get.mjs → server/api/v1/apikeys/[id]/user.get.mjs b/server/api/v1/apikey/[id]/user.get.mjs → server/api/v1/apikeys/[id]/user.get.mjs