Skip to content

Commit

Permalink
fix(docs): fixed sourcing for roles-and-permissions api spec
Browse files Browse the repository at this point in the history
  • Loading branch information
@webspaceadam
webspaceadam committed Dec 8, 2023
1 parent 25dc098 commit d182ff7
Show file tree
Hide file tree
Showing 4 changed files with 131 additions and 73 deletions.
2 changes: 2 additions & 0 deletions .gitignore
View file
Original file line number Diff line number Diff line change
Expand Up @@ -160,3 +160,5 @@ apps/swirl-docs/users.yml
apps/swirl-docs/usergroups.yml
apps/swirl-docs/channels.yml
apps/swirl-docs/src/documents/api/*
apps/swirl-docs/roles-and-permissions.yml
apps/swirl-docs/users-common.yml
5 changes: 3 additions & 2 deletions apps/swirl-docs/src/lib/docs/src/oasBuilderSetup.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,9 @@ export default class OASBuilder implements IOASBuilder {
}

public setOperations() {
if (Object.keys(this.paths).length === 0)
throw new Error("Endpoints not set");
if (Object.keys(this.paths).length === 0) {
this.paths = this._oasBuilder.api.paths || {};
}

for (const path in this.paths) {
const operationInPaths = this.paths[path];
Expand Down
195 changes: 124 additions & 71 deletions apps/swirl-docs/src/lib/navigation/src/data/apiSpecs.data.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -309,6 +309,26 @@ export const apiSpecsNavItems: NavItem[] = [
],
specName: "posts.yml",
},
{
title: "Roles & Permissions",
url: "/api-docs/roles-&-permissions",
isRoot: true,
children: [
{
title: "List roles",
url: "/api-docs/roles-&-permissions#get-all-roles",
description: "get",
isRoot: false,
},
{
title: "Get role",
url: "/api-docs/roles-&-permissions#get-role",
description: "get",
isRoot: false,
},
],
specName: "roles-and-permissions.yml",
},
{
title: "Sharepoint Pages",
url: "/api-docs/sharepoint-pages",
Expand Down Expand Up @@ -587,191 +607,224 @@ export const apiSpecsNavItems: NavItem[] = [
specName: "usergroups.yml",
},
{
title: "User Management",
url: "/api-docs/user-management-api",
title: "User Admin",
url: "/api-docs/user-admin-api",
isRoot: true,
children: [
{
title: "List all users",
url: "/api-docs/user-management-api#search-users",
url: "/api-docs/user-admin-api#search-users",
description: "get",
isRoot: false,
},
{
title: "Get user",
url: "/api-docs/user-management-api#get-user",
url: "/api-docs/user-admin-api#get-user",
description: "get",
isRoot: false,
},
{
title: "List linkable identity providers",
url: "/api-docs/user-management-api#get-linkable-identity-providers",
url: "/api-docs/user-admin-api#get-linkable-identity-providers",
description: "get",
isRoot: false,
},
{
title: "List linked identities for user",
url: "/api-docs/user-management-api#get-linked-identities",
url: "/api-docs/user-admin-api#get-linked-identities",
description: "get",
isRoot: false,
},
{
title: "Check OTP configuration",
url: "/api-docs/user-management-api#has-otp",
url: "/api-docs/user-admin-api#has-otp",
description: "get",
isRoot: false,
},
{
title: "Check password configuration",
url: "/api-docs/user-management-api#has-password",
description: "get",
isRoot: false,
},
{
title: "Check my password configuration",
url: "/api-docs/user-management-api#do-I-have-a-password",
description: "get",
isRoot: false,
},
{
title: "Get my email address",
url: "/api-docs/user-management-api#get-my-email-address",
url: "/api-docs/user-admin-api#has-password",
description: "get",
isRoot: false,
},
{
title: "List my on-leave notes",
url: "/api-docs/user-management-api#get-on-leave-notes",
description: "get",
isRoot: false,
},
{
title: "Get my on-leave note",
url: "/api-docs/user-management-api#get-on-leave-note",
description: "get",
isRoot: false,
},
{
title: "List mentionable users",
url: "/api-docs/user-management-api#get-mentionable-users-for-on-leave",
title: "List assigned organisation roles for user",
url: "/api-docs/user-admin-api#get-user-roles",
description: "get",
isRoot: false,
},
{
title: "Create user",
url: "/api-docs/user-management-api#create-user",
url: "/api-docs/user-admin-api#create-user",
description: "post",
isRoot: false,
},
{
title: "Lock user",
url: "/api-docs/user-management-api#lock-user",
url: "/api-docs/user-admin-api#lock-user",
description: "post",
isRoot: false,
},
{
title: "Unlock User",
url: "/api-docs/user-management-api#unlock-user",
url: "/api-docs/user-admin-api#unlock-user",
description: "post",
isRoot: false,
},
{
title: "Link identity to user",
url: "/api-docs/user-management-api#create-linked-identity",
url: "/api-docs/user-admin-api#create-linked-identity",
description: "post",
isRoot: false,
},
{
title: "Reset password",
url: "/api-docs/user-management-api#change-password",
url: "/api-docs/user-admin-api#change-password",
description: "post",
isRoot: false,
},
{
title: "Send account actions email",
url: "/api-docs/user-management-api#send-account-actions-email",
url: "/api-docs/user-admin-api#send-account-actions-email",
description: "post",
isRoot: false,
},
{
title: "Send multiple account actions emails",
url: "/api-docs/user-management-api#send-account-actions-emails-batch",
description: "post",
isRoot: false,
},
{
title: "Change my password",
url: "/api-docs/user-management-api#change-my-password",
url: "/api-docs/user-admin-api#send-account-actions-emails-batch",
description: "post",
isRoot: false,
},
{
title: "Change my email address",
url: "/api-docs/user-management-api#change-my-account-email",
title: "Assign organisation role to user",
url: "/api-docs/user-admin-api#assign-role-to-user",
description: "post",
isRoot: false,
},
{
title: "Notify logged in",
url: "/api-docs/user-management-api#logged-in",
description: "post",
isRoot: false,
},
{
title: "Create on-leave note",
url: "/api-docs/user-management-api#create-on-leave-note",
title: "Assign organisation roles to users",
url: "/api-docs/user-admin-api#assign-role-to-user-batch",
description: "post",
isRoot: false,
},
{
title: "Update user",
url: "/api-docs/user-management-api#update-user",
description: "patch",
isRoot: false,
},
{
title: "Update on-leave note",
url: "/api-docs/user-management-api#update-on-leave-note",
url: "/api-docs/user-admin-api#update-user",
description: "patch",
isRoot: false,
},
{
title: "Delete user",
url: "/api-docs/user-management-api#delete-user",
url: "/api-docs/user-admin-api#delete-user",
description: "delete",
isRoot: false,
},
{
title: "Delete multiple users",
url: "/api-docs/user-management-api#delete-users-batch",
url: "/api-docs/user-admin-api#delete-users-batch",
description: "delete",
isRoot: false,
},
{
title: "Delete linked identity",
url: "/api-docs/user-management-api#delete-linked-identity",
url: "/api-docs/user-admin-api#delete-linked-identity",
description: "delete",
isRoot: false,
},
{
title: "Delete OTP",
url: "/api-docs/user-management-api#delete-otp",
url: "/api-docs/user-admin-api#delete-otp",
description: "delete",
isRoot: false,
},
{
title: "Delete password",
url: "/api-docs/user-management-api#delete-password",
url: "/api-docs/user-admin-api#delete-password",
description: "delete",
isRoot: false,
},
],
specName: "users-admin.yml",
},
{
title: "User Me",
url: "/api-docs/user-me-api",
isRoot: true,
children: [],
specName: "users-common.yml",
},
{
title: "User Me",
url: "/api-docs/user-me-api",
isRoot: true,
children: [
{
title: "Check my password configuration",
url: "/api-docs/user-me-api#do-I-have-a-password",
description: "get",
isRoot: false,
},
{
title: "Get my email address",
url: "/api-docs/user-me-api#get-my-email-address",
description: "get",
isRoot: false,
},
{
title: "List my on-leave notes",
url: "/api-docs/user-me-api#get-on-leave-notes",
description: "get",
isRoot: false,
},
{
title: "Get my on-leave note",
url: "/api-docs/user-me-api#get-on-leave-note",
description: "get",
isRoot: false,
},
{
title: "List mentionable users",
url: "/api-docs/user-me-api#get-mentionable-users-for-on-leave",
description: "get",
isRoot: false,
},
{
title: "Change my password",
url: "/api-docs/user-me-api#change-my-password",
description: "post",
isRoot: false,
},
{
title: "Change my email address",
url: "/api-docs/user-me-api#change-my-account-email",
description: "post",
isRoot: false,
},
{
title: "Notify logged in",
url: "/api-docs/user-me-api#logged-in",
description: "post",
isRoot: false,
},
{
title: "Create on-leave note",
url: "/api-docs/user-me-api#create-on-leave-note",
description: "post",
isRoot: false,
},
{
title: "Update on-leave note",
url: "/api-docs/user-me-api#update-on-leave-note",
description: "patch",
isRoot: false,
},
{
title: "Delete on-leave note",
url: "/api-docs/user-management-api#delete-on-leave-note",
url: "/api-docs/user-me-api#delete-on-leave-note",
description: "delete",
isRoot: false,
},
],
specName: "users.yml",
specName: "users-me.yml",
},
];
2 changes: 2 additions & 0 deletions apps/swirl-docs/src/scripts/DeploymentStrategy/FileOperator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ export class FileOperator {
"usergroups.yml",
"users.yml",
"channels.yml",
"users-common.yml",
"roles-and-permissions.yml",
];

constructor(private strategy: DeploymentStrategy["strategy"]) {}
Expand Down

2 comments on commit d182ff7

@vercel
Copy link

@vercel vercel bot commented on d182ff7 Dec 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

getflipdev – ./apps/swirl-docs

getflipdev-git-main-getflip.vercel.app
getflipdev.vercel.app
getflipdev-getflip.vercel.app
getflip.dev
www.getflip.dev

@vercel
Copy link

@vercel vercel bot commented on d182ff7 Dec 8, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

staginggetflipdev – ./apps/swirl-docs

staginggetflipdev.vercel.app
staginggetflipdev-getflip.vercel.app
staginggetflipdev-git-main-getflip.vercel.app
www.staging.getflip.dev
staging.getflip.dev

Please sign in to comment.