Skip to content

Commit 9308027

Browse files
rizenrizen
committed
Implemented: apis should use plurals #183 
1 parent ade6ccf commit 9308027

File tree

94 files changed

+203
-178
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+203
-178
lines changed

‎app/components/ving/Dropzone.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ import '../node_modules/dropzone/dist/dropzone.css'
1616
Dropzone.autoDiscover = false;
1717
1818
const getSignedURL = async (file) => {
19-
const response = await useRest(`/api/${useRestVersion()}/s3file?includeMeta=true`, {
19+
const response = await useRest(`/api/${useRestVersion()}/s3files?includeMeta=true`, {
2020
method: 'POST', body: {
2121
contentType: file.type,
2222
filename: file.name,

‎app/composables/ving/useAdminLinks.mjs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,9 @@
88
export default () => {
99
const links = computed(() => {
1010
const out = [
11-
{ label: 'Cron Jobs', to: '/cronjob', icon: 'ph:clock' },
11+
{ label: 'Cron Jobs', to: '/cronjobs', icon: 'ph:clock' },
1212
{ label: 'System Wide Alert', to: '/system-wide-alert', icon: 'ph:megaphone' },
13-
{ label: 'Users', to: '/user/admin', icon: 'ph:users' },
13+
{ label: 'Users', to: '/users/admin', icon: 'ph:users' },
1414
];
1515
return out;
1616
});

‎app/composables/ving/useCurrentUser.mjs

+4-4
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ import { isUndefined } from '#ving/utils/identify.mjs';
33

44
export const useCurrentUser = () => useVingRecord({
55
id: 'currentUser',
6-
fetchApi: `/api/${useRestVersion()}/user/whoami`,
7-
createApi: `/api/${useRestVersion()}/user`,
6+
fetchApi: `/api/${useRestVersion()}/users/whoami`,
7+
createApi: `/api/${useRestVersion()}/users`,
88
query: { includeOptions: true, includeMeta: true, includeLinks: true },
99
extendedActions: {
1010
async login(login, password) {
11-
const response = await useRest(`/api/${useRestVersion()}/session`, {
11+
const response = await useRest(`/api/${useRestVersion()}/sessions`, {
1212
method: 'post',
1313
body: {
1414
login,
@@ -24,7 +24,7 @@ export const useCurrentUser = () => useVingRecord({
2424
},
2525

2626
async logout() {
27-
const response = await useRest(`/api/${useRestVersion()}/session`, {
27+
const response = await useRest(`/api/${useRestVersion()}/sessions`, {
2828
method: 'delete',
2929
});
3030
this.setState({});

‎app/composables/ving/useMessageBus.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ export default async function useMessageBus() {
2929
const reconnect = () => setTimeout(tryToSetup, wait);
3030

3131
const setupBusHandler = () => {
32-
bus = new EventSource(`/api/${useRestVersion()}/user/messagebus`);
32+
bus = new EventSource(`/api/${useRestVersion()}/users/messagebus`);
3333
bus.onmessage = (event) => {
3434
const message = JSON.parse(event.data);
3535
switch (message.type) {

‎app/composables/ving/useRest.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
*
1515
* The `error` is `null` unless there is an error, and the `data` contains an object response from the endpoint.
1616
* @example
17-
* const response = await useRest('/api/v1/user/xxx')
17+
* const response = await useRest('/api/v1/users/xxx')
1818
*/
1919
export default async function (url, behavior = {}) {
2020
const notify = useNotify();

‎app/composables/ving/useUserSettingsButtons.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ export default () => {
99
const currentUser = useCurrentUser();
1010
const buttons = computed(() => {
1111
const out = [
12-
{ label: 'Sign Out', to: '/user/logout', icon: 'ph:door', severity: 'primary' },
12+
{ label: 'Sign Out', to: '/users/logout', icon: 'ph:door', severity: 'primary' },
1313
];
1414
if (currentUser.props?.admin)
1515
out.push({ label: 'Admin', to: '/admin', icon: 'ph:users', severity: 'secondary' });

‎app/composables/ving/useUserSettingsLinks.mjs

+4-4
Original file line numberDiff line numberDiff line change
@@ -9,12 +9,12 @@ export default () => {
99
const currentUser = useCurrentUser();
1010
const links = computed(() => {
1111
const out = [
12-
{ label: 'Profile', to: '/user/settings', icon: 'ph:user' },
13-
{ label: 'Account', to: '/user/settings/account', icon: 'ph:key' },
14-
{ label: 'Preferences', to: '/user/settings/preferences', icon: 'ph:sliders' },
12+
{ label: 'Profile', to: '/users/settings', icon: 'ph:user' },
13+
{ label: 'Account', to: '/users/settings/account', icon: 'ph:key' },
14+
{ label: 'Preferences', to: '/users/settings/preferences', icon: 'ph:sliders' },
1515
];
1616
if (currentUser?.props?.developer == true)
17-
out.push({ label: 'API Keys', to: '/user/settings/apikeys', icon: 'ph:lock' });
17+
out.push({ label: 'API Keys', to: '/users/settings/apikeys', icon: 'ph:lock' });
1818
return out;
1919
});
2020
return links;

‎app/composables/ving/useVingKind.mjs

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ class VingKind {
145145
* @param {object} options Modify the behavior of this call.
146146
* @returns {Promise<object>} A promise containing the response to the call.
147147
* @example
148-
* const result = Users.call('post', '/user/xxx/send-reset-password', {os:'Windows'});
148+
* const result = Users.call('post', '/users/xxx/send-reset-password', {os:'Windows'});
149149
*/
150150
async call(method, url, query = {}, options = {}) {
151151
const response = await useRest(url, {

‎app/composables/ving/useVingRecord.mjs

+2-2
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,8 @@ import { isObject, isUndefined } from '#ving/utils/identify.mjs';
3232
* @example
3333
* const user = useVingRecord({
3434
* id : 'xxx',
35-
* fetchApi: '/api/v1/user/xxx',
36-
* createApi: '/api/v1/user',
35+
* fetchApi: '/api/v1/users/xxx',
36+
* createApi: '/api/v1/users',
3737
* query : { includeMeta : true },
3838
* });
3939
* await user.fetch();

‎app/layouts/default.vue

+4-4
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
<InputText placeholder="Search (non-functional)" type="text" class="w-8rem sm:w-auto" />
2929
</InputGroup>
3030
<SplitButton v-if="currentUser.props?.id" :model="userMenu" text>
31-
<NuxtLink to="/user/settings" class="flex items-center">
31+
<NuxtLink to="/users/settings" class="flex items-center">
3232
<Avatar :image="currentUser.links?.avatarImage?.href" alt="user avatar" shape="circle" />
3333
<span class="ml-2">
3434
{{ currentUser.meta?.displayName }}
@@ -41,7 +41,7 @@
4141
</NuxtLink>
4242
</template>
4343
</SplitButton>
44-
<NuxtLink v-else to="/user/login" class="flex p-3 items-center text-nowrap">
44+
<NuxtLink v-else to="/users/login" class="flex p-3 items-center text-nowrap">
4545
<Icon name="fa6-solid:door-open" class="mr-2" />
4646
Sign In
4747
</NuxtLink>
@@ -82,8 +82,8 @@ const topNav = [
8282
8383
const userMenu = computed(() => {
8484
const out = [
85-
{ label: 'Settings', to: '/user/settings', icon: 'fa6-solid:sliders' },
86-
{ label: 'Sign Out', to: '/user/logout', icon: 'fa6-solid:door-closed' },
85+
{ label: 'Settings', to: '/users/settings', icon: 'fa6-solid:sliders' },
86+
{ label: 'Sign Out', to: '/users/logout', icon: 'fa6-solid:door-closed' },
8787
];
8888
if (currentUser.props.admin)
8989
out.unshift({ label: 'Admin', to: '/admin', icon: 'prime:user-plus' });

‎app/middleware/auth.mjs

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@ export default defineNuxtRouteMiddleware(async (to, from) => {
22
const currentUser = useCurrentUser();
33
const isAuthenticated = await currentUser.isAuthenticated();
44
if (!isAuthenticated) {
5-
return await navigateTo(`/user/login?redirectAfter=${to.fullPath}`);
5+
return await navigateTo(`/users/login?redirectAfter=${to.fullPath}`);
66
}
77
else if (!currentUser.props?.verifiedEmail) {
8-
if (to.fullPath != '/user/logout') {
9-
return await navigateTo(`/user/must-verify-email?redirectAfter=${to.fullPath}`);
8+
if (to.fullPath != '/users/logout') {
9+
return await navigateTo(`/users/must-verify-email?redirectAfter=${to.fullPath}`);
1010
}
1111
}
1212
});

‎app/pages/admin.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@
22

33
</template>
44
<script setup>
5-
navigateTo('/user/admin');
5+
navigateTo('/users/admin');
66
</script>

‎app/pages/cronjob/[id]/edit.vue ‎app/pages/cronjobs/[id]/edit.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,8 @@ const notify = useNotify();
4242
const id = route.params.id.toString();
4343
const cronjob = useVingRecord({
4444
id,
45-
fetchApi: `/api/${useRestVersion()}/cronjob/${id}`,
46-
createApi: `/api/${useRestVersion()}/cronjob`,
45+
fetchApi: `/api/${useRestVersion()}/cronjobs/${id}`,
46+
createApi: `/api/${useRestVersion()}/cronjobs`,
4747
query: { includeMeta: true, includeOptions: true },
4848
onUpdate() {
4949
notify.success('Updated Cron Job.');

‎app/pages/cronjob/index.vue ‎app/pages/cronjobs/index.vue

+5-2
Original file line numberDiff line numberDiff line change
@@ -48,10 +48,13 @@ definePageMeta({
4848
middleware: ['auth', 'admin']
4949
});
5050
const cronjobs = useVingKind({
51-
listApi: `/api/${useRestVersion()}/cronjob`,
52-
createApi: `/api/${useRestVersion()}/cronjob`,
51+
listApi: `/api/${useRestVersion()}/cronjobs`,
52+
createApi: `/api/${useRestVersion()}/cronjobs`,
5353
query: { includeMeta: true, sortBy: 'schedule', sortOrder: 'asc' },
5454
newDefaults: { schedule: '* * * * *', handler: 'Test', enabled: true },
55+
onCreate(props) {
56+
navigateTo(props.links.edit.href)
57+
},
5558
});
5659
await Promise.all([
5760
cronjobs.search(),

‎app/pages/user/[id]/profile.vue ‎app/pages/users/[id]/profile.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@
3333
const route = useRoute();
3434
3535
const user = useVingRecord({
36-
fetchApi: `/api/${useRestVersion()}/user/${route.params.id}`,
37-
createApi: `/api/${useRestVersion()}/user`,
36+
fetchApi: `/api/${useRestVersion()}/users/${route.params.id}`,
37+
createApi: `/api/${useRestVersion()}/users`,
3838
query: { includeMeta: true, includeOptions: true },
3939
});
4040
await user.fetch()

‎app/pages/user/[id]/reset-password.vue ‎app/pages/users/[id]/reset-password.vue

+3-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img :src="config.public.site.logoUrl" :alt="config.public.site.name" height="50" class="mb-3">
66
<h1 class="text-900 text-3xl font-medium mb-3 mt-0">Reset Password</h1>
77
<span class="text-600 font-medium line-height-3">Remember your account?</span>
8-
<NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
8+
<NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
99
</NuxtLink>
1010
</div>
1111
<PanelZone>
@@ -41,14 +41,14 @@ const config = useRuntimeConfig();
4141
const notify = useNotify();
4242
async function resetPassword() {
4343
notify.info('Please wait while we reset your password...');
44-
const response = await useRest(`/api/${useRestVersion()}/user/${route.params.id}/reset-password`, {
44+
const response = await useRest(`/api/${useRestVersion()}/users/${route.params.id}/reset-password`, {
4545
method: 'post',
4646
query: { includeOptions: true },
4747
body: { code: newPassword.code, password: newPassword.password },
4848
});
4949
if (!response.error) {
5050
notify.success('Password changed.');
51-
await navigateTo('/user/login');
51+
await navigateTo('/users/login');
5252
}
5353
}
5454
</script>

‎app/pages/user/admin/[id].vue ‎app/pages/users/admin/[id].vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -88,8 +88,8 @@ const notify = useNotify();
8888
const id = route.params.id.toString();
8989
const user = useVingRecord({
9090
id,
91-
fetchApi: `/api/${useRestVersion()}/user/${id}`,
92-
createApi: `/api/${useRestVersion()}/user`,
91+
fetchApi: `/api/${useRestVersion()}/users/${id}`,
92+
createApi: `/api/${useRestVersion()}/users`,
9393
query: { includeMeta: true, includeOptions: true },
9494
onUpdate() {
9595
notify.success('Updated user.');

‎app/pages/user/admin/index.vue ‎app/pages/users/admin/index.vue

+5-2
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,13 @@ definePageMeta({
8080
});
8181
8282
const users = useVingKind({
83-
listApi: `/api/${useRestVersion()}/user`,
84-
createApi: `/api/${useRestVersion()}/user`,
83+
listApi: `/api/${useRestVersion()}/users`,
84+
createApi: `/api/${useRestVersion()}/users`,
8585
query: { includeMeta: true, sortBy: 'username', sortOrder: 'asc' },
8686
newDefaults: { username: '', realName: '', email: '' },
87+
onCreate(props) {
88+
navigateTo(props.links.edit.href)
89+
},
8790
});
8891
await users.search();
8992

‎app/pages/user/create.vue ‎app/pages/users/create.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
66
<h1 class="text-900 text-3xl font-medium mb-3 mt-0">Create an Account</h1>
77
<span class="text-600 font-medium line-height-3">Already have an account?</span>
8-
<NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
8+
<NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
99
</NuxtLink>
1010
</div>
1111
<PanelZone>

‎app/pages/user/login.vue ‎app/pages/users/login.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
66
<h1 class="text-900 text-3xl font-medium mb-3 mt-0">Welcome Back</h1>
77
<span class="text-600 font-medium line-height-3">Don't have an account?</span>
8-
<NuxtLink to="/user/create" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Create one today!
8+
<NuxtLink to="/users/create" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Create one today!
99
</NuxtLink>
1010
</div>
1111
<PanelZone>
@@ -22,7 +22,7 @@
2222

2323
<div class="mt-3">
2424
<span class="text-600 font-medium line-height-3">Forgot your password?</span>
25-
<NuxtLink to="/user/reset-password" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Reset
25+
<NuxtLink to="/users/reset-password" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Reset
2626
your
2727
password.
2828
</NuxtLink>

‎app/pages/user/logout.vue ‎app/pages/users/logout.vue

File renamed without changes.

‎app/pages/user/must-verify-email.vue ‎app/pages/users/must-verify-email.vue

File renamed without changes.

‎app/pages/user/reset-password.vue ‎app/pages/users/reset-password.vue

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<img :src="config.public.site.logoUrl" :alt="config.public.site.name" class="inline-block h-16 mb-3">
66
<h1 class="text-900 text-3xl font-medium mb-3 mt-0">Send Password Reset</h1>
77
<span class="text-600 font-medium line-height-3">Remember your account?</span>
8-
<NuxtLink to="/user/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
8+
<NuxtLink to="/users/login" class="font-medium no-underline ml-2 text-blue-500 cursor-pointer">Sign in
99
</NuxtLink>
1010
</div>
1111
<PanelZone info="Where should we send the password reset email?">
@@ -33,7 +33,7 @@ const email = ref('')
3333
const notify = useNotify();
3434
async function sendPasswordReset() {
3535
const parser = new ua(navigator.userAgent);
36-
const response = await useRest(`/api/${useRestVersion()}/user/send-password-reset`, {
36+
const response = await useRest(`/api/${useRestVersion()}/users/send-password-reset`, {
3737
method: 'post',
3838
query: { includeOptions: true },
3939
body: { browser: parser.getBrowser().name, os: parser.getOS().name, email: email.value }

‎app/pages/user/settings/account.vue ‎app/pages/users/settings/account.vue

File renamed without changes.

‎app/pages/user/settings/apikeys.vue ‎app/pages/users/settings/apikeys.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ const links = useUserSettingsLinks();
9292
const buttons = useUserSettingsButtons();
9393
const apikeys = useVingKind({
9494
listApi: currentUser.links?.apikeys.href,
95-
createApi: `/api/${useRestVersion()}/apikey`,
95+
createApi: `/api/${useRestVersion()}/apikeys`,
9696
query: { includeMeta: true, sortBy: 'name', sortOrder: 'asc' },
9797
newDefaults: { name: 'My New API Key', reason: '', url: 'http://', userId: currentUser.props?.id },
9898
});

‎app/pages/user/settings/index.vue ‎app/pages/users/settings/index.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828

2929
<FormInput type="markdown" @change="currentUser.save('bio')" label="Bio" v-model="currentUser.props.bio" name="bio" class="mb-4" />
3030

31-
<NuxtLink :to="'/user/' + currentUser.props.id + '/profile'">
31+
<NuxtLink :to="currentUser.links.profile.href">
3232
View your profile as others see it
3333
</NuxtLink>
3434
</PanelZone>

‎app/pages/user/settings/preferences.vue ‎app/pages/users/settings/preferences.vue

File renamed without changes.

‎app/pages/user/verify-email.vue ‎app/pages/users/verify-email.vue

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ if (await currentUser.isAuthenticated()) {
2929
}
3030
}
3131
else {
32-
await navigateTo('/user/login')
32+
await navigateTo('/users/login')
3333
}
3434
3535
</script>

‎server/api/v1/apikey/[id]/index.delete.mjs ‎server/api/v1/apikeys/[id]/index.delete.mjs

File renamed without changes.

‎server/api/v1/apikey/[id]/index.get.mjs ‎server/api/v1/apikeys/[id]/index.get.mjs

File renamed without changes.

‎server/api/v1/apikey/[id]/index.put.mjs ‎server/api/v1/apikeys/[id]/index.put.mjs

File renamed without changes.

‎server/api/v1/apikey/[id]/user.get.mjs ‎server/api/v1/apikeys/[id]/user.get.mjs

File renamed without changes.

0 commit comments

Comments
 (0)