From 3c9b10967caa8813c49bb8f0d5385b76ced2e777 Mon Sep 17 00:00:00 2001 From: Rachid F Date: Sat, 4 May 2024 21:27:51 -0700 Subject: [PATCH] :lipstick: Adding references to docs in webapp --- apps/client-ts/public/logo-panora-black.png | Bin 0 -> 2053 bytes .../client-ts/public/logo-panora-white-hq.png | Bin 0 -> 2232 bytes .../src/app/(Dashboard)/api-keys/page.tsx | 20 ++-- .../app/(Dashboard)/configuration/page.tsx | 6 +- .../src/app/(Dashboard)/connections/page.tsx | 3 +- .../Configuration/AddAuthCredentials.tsx | 2 +- .../Configuration/AddAuthCredentialsForm.tsx | 14 +-- .../components/Configuration/AddWebhook.tsx | 16 ++-- .../Configuration/FieldMappingModal.tsx | 48 ++++------ .../Connection/AddConnectionButton.tsx | 12 +-- .../client-ts/src/components/Nav/main-nav.tsx | 4 +- .../src/components/RootLayout/index.tsx | 5 +- docs/welcome.mdx | 24 ----- packages/api/swagger/swagger-spec.json | 89 ++++++------------ packages/api/variables.MD | 6 ++ 15 files changed, 92 insertions(+), 157 deletions(-) create mode 100644 apps/client-ts/public/logo-panora-black.png create mode 100644 apps/client-ts/public/logo-panora-white-hq.png create mode 100644 packages/api/variables.MD diff --git a/apps/client-ts/public/logo-panora-black.png b/apps/client-ts/public/logo-panora-black.png new file mode 100644 index 0000000000000000000000000000000000000000..2c43e46534e194a3b8df8b0aaabcc6d3369ba41e GIT binary patch literal 2053 zcmb7_X*kpi8^-^mXqGU>GK?WJ=8a0qZqgBBhClNX(t^gm#W~qWV>zM`GeQ(2Ta@Lc z?23#-G~yVYD2Z%Yi;N|t!gTb0IG^A5!?Rq^b$@uS>%On+$FjAt5Qk&n004+vf@FID zfWUTlC#cwNe;|6FwL4%zpkpWiAf$g51jxyg2Y`KzmSj_hD|v$aonSl>*?HhR2SAIU zMI_=7?TYbA@vwI0RWn1MHc;)y9NVF^_!4tF0c*R+>V~HwL~h+@Wcr zkt7fuo2d!lc=|FhQWBcI7so?T;*nDccvI*qDP4tmr3gflT5JhWoQpb&i9Gg?j6Z>s zeBo1%21a_liF<|`gu*7_0USYR+~^{QUt$2c0tq^FdmM7ItYSZ@`|g#kSW*1sE7()# z@d~_G&e!j;)&ZzcU6)SuRqx3Qgx`6?8RO*lZe_w;*6v`b5SADt? z&PbB9?YSV3VqpsXlP6F1fGkBKGg7pY_L`)t5EP$~JtW=avIpPFgf@prEYXn}qKE?C zT#gX3f{3hrFLDs4P@{tSjSdt5(MOEARu|<+&_&kXJ}B?ORA};mD2_QK11ofVZ3sQ3 z^U@AUDos6`4$R;oeYq+GqUkCDUgXFD<3?;~9c`Xg(eYfNXG^xB>AP(iq zhNsswXX%teluM-7ef1mg>G<(3Ze4GTMn5+HH0|Xf9^RZlh}V!};pvX|!H2gqksTt8 z8~T*8*GbIhQQdDYZx(Ch4z29zV>8zy5|YSv+=teLxtn?gR96T?Qpuf)K|35qEi3fo zb=ar$w0&LE}ZXdmydXVI5G^r<=<ZR+<4BVW}TQ^16A^Ws5f^LmkZouE5ZbVuK%n`KMI z9gy@N#_V5Z9VQm zTx>4LE2yKUc#TvC@;I1EuQ8Kbv94;%ad2h-NTb~dp`OY=->I~;@X0o%p7&C! zZP~wyIS?28WhZT0C0yme{JnRHE8n78s~O z=}@~{#mM5X%rK3y5*b%ba|T}z#fBVvYC|A_YQNhTVZA=A}jmzmJ3ao zxXQAjWIF^!S#G56Ft->SH8hD>kLp=g$&3`OT??8g#s?M~@iH?i7DE>CxN`MMtK6{( zW#9!(Ou!Zz&4@@xohP8r4$lrzNbx>P3#t7!3iIj)7NMOqOqh9npYQzRnye|hWqMPQ zxU~L;!JPnCD=tMXCFTZFF}DVU4pg5cbJ&8eV|_3yr3^He?fyaUxJe{(a= zwi$1hm}QBH@&GI9euh1a5G=O!QTB6HZK_}DE1R)ve)Vycq8)m_UXD4jP)FSpxYF|{ zcJ`TIEG^a8V?0Eu10T#-UQ=G~hJRb(P@|8VVp e#NYod`>g2krPH_us-eBhb-IcWev1{zJNDpi>!7z~AFlOZrtcxDsEPc|}rM@$@@Tl;T&L zRSqaB(1<8O0Flv9RN`eM1a2q;BjiZ%bD_}CbPyZ~F-e5N2$F^nF4X@j8}6&zAfe#-gOe^wB6 zL%0r+2ImBH&;1f4qN6a}9nrbfeO2JLn2>D<@86y5RaPBay zp0BYZ`ORx2fxl`u>~Dw{=iIr3Ph3kQ>XLARJGs(k{*3;2S9X)c9CK=f`^G~z66N&= zC~7#`H3M{sDABK0oBc}E*)^Ba9}SE#^Bl{=6Ona$A@n;6;ifUn*|_`8@7-sy3aQ3& zj$6E;;TNkitv_<6@Q;p+Wfz3)SR}U$I=zz#Q-Za`8~zfq{ptSm*K{23{yx~xSh3|u ziE9$p!``*A4vRcBAv`{aEyedC@<*39)rUIg+pVJ;D)Ad5+IwUgv!D}yqaiRu^a*i7 z^yt_0%I3AzTck(&eXenbUrJ(!XS*g3#b*wBf9w~VM{3{ZWVp4g?V z$||&c$?XxlA7LIf7O6(ryQP2kE%IgX6P>k|4vi1vA~j~FZ?+|fmk+4C{|jDc=1I(_ zg=fVA#A}3#uJ(M&t=goQ;z%p*y&OHH*Gr;Jpr=WjcO5^6M02z~38rJ+GWrGE7eCoC ztKM?$rSITm{M42v1zYKM$#`>dT{6AtP<=biPhP6*4yHIr3U;N;dgjc8DNKY~YhYWk zF~H%M=?^>##kr6VCN@P+u!LHez1^@kJ@umu{xo&k{O0HPDgy;5@+0sx(^lS=;brHs zfE!j#uVl)6f!Wj`_%qlhl!Kb}7`a+K6M3zJfG1aEkC%h<+sr9 z8td~kpt&L>C0yU#JxY$h{AbvBpTC8Wcy^I+mBJb3Ta{;?j0WMTBqt|DP|-2@Gj4-^ zYunoh+H`hGpVHQ2J%=FP>YaWbPN6N&MPU)1tc)Wxwv5505ssudlzHYToK4C0$H>|= zXl^I82AKVk?B$mD&Cg|JDSp>gRvL=${XsRo z_{?TE9dA>3egG@XO)0!rRB!5SE*+4L4lLClZxJb8e{r+zZkN_*4r1PX{i-DP=jHSD z-?LZZ%2zsY2}WIeN7d15Nl`RlcJk_|4RK_w{HI1GP|+U{&X^>N(tX(Pm!dUdWb0e zvQ@p-oGh*$_skSU+{;*Rpd?8O=U9>)vDK&EDb6U8o>#V6)YIJdFG1^~eA0p0(xvR;lQr{hk(a%Sy32I9ydUTtX2^8Ax6`l5pMvf(o(lJOi zmxO6`;B&gpya!`{e6!kA+T77G*ih)WdB|@~h^ZM?8l>*fAzc)2(V$1J?Uo&Ja$M=f zE+Jt>_TDF-uTlBc;+`ja$T)6+^Zu+QjuxYSw-QrLbez;h9zPxiUc4K3>A*v->3K2} z=iH&<5KuI^rjS9vk~0G#7T=WS*bnl#MF^x9dNeJ6Fp74FFHifumyd&nQIHbb1s_?Vi7yA+G9wyA=kzwDA_X!`rr)vudkE@f;Sha>s#DDO zM)elSZP_TOu){ITyBS|}0}%JxXlWP`sKwPlMQ|Kbs!5zA(}>?x@)|~Ms3)||rF}-5 zLfb9`H{CUJTO=S@%^>F*E1Iym{8ohWI!%*xc-y!z6tBbjKqV=YuK6&qOXp!d531dC zobF4t8T7~|3q}{-hQ~cgkBsU&$_||$7tYm)U78(zXLDvSXYt7B(c`}el`&z7-xGA% zr_jvVWR<4%#0B86YMZ*{F==MUn$0u&7M%z!PeA;i(*55Q{s0_vMTRZ$qze4_6#-yO Ltc@E{UWxwz*F6&H literal 0 HcmV?d00001 diff --git a/apps/client-ts/src/app/(Dashboard)/api-keys/page.tsx b/apps/client-ts/src/app/(Dashboard)/api-keys/page.tsx index 370605b82..b68f8cd0b 100644 --- a/apps/client-ts/src/app/(Dashboard)/api-keys/page.tsx +++ b/apps/client-ts/src/app/(Dashboard)/api-keys/page.tsx @@ -122,8 +122,13 @@ export default function Page() {
+ Create a key that unlocks full API access to this project. + More details in our documentation. + + } />
@@ -160,9 +165,9 @@ export default function Page() { ( <> - Add New Api Key + Create a new API key - Never share this key, you must saved it it will be displayed once ! + Keep your key safe.

Save and store this new key to a secure place, such as a password manager or secret store. You won't be able to see it again. @@ -175,16 +180,13 @@ export default function Page() { name="apiKeyIdentifier" render={({ field }) => ( - API Key Identifier + Name your API key - - This is the API Key Identifier of system. - )} diff --git a/apps/client-ts/src/app/(Dashboard)/configuration/page.tsx b/apps/client-ts/src/app/(Dashboard)/configuration/page.tsx index 422e9bf74..bec142a15 100644 --- a/apps/client-ts/src/app/(Dashboard)/configuration/page.tsx +++ b/apps/client-ts/src/app/(Dashboard)/configuration/page.tsx @@ -131,7 +131,7 @@ export default function Page() { Webhooks - 0Auth Credentials + OAuth Credentials @@ -179,7 +179,8 @@ export default function Page() { Your Fields Mapping - You built {mappings ? mappings.length : } fields mapping. + You built {mappings ? mappings.length : } fields mappings. + Learn more about custom field mappings @@ -198,6 +199,7 @@ export default function Page() { Your Webhooks You enabled {webhooks ? webhooks.length : } webhooks. + Read more about webhooks from our documentation diff --git a/apps/client-ts/src/app/(Dashboard)/connections/page.tsx b/apps/client-ts/src/app/(Dashboard)/connections/page.tsx index e9fc5059b..b0285f8c2 100644 --- a/apps/client-ts/src/app/(Dashboard)/connections/page.tsx +++ b/apps/client-ts/src/app/(Dashboard)/connections/page.tsx @@ -12,7 +12,8 @@ export default function ConnectionPage() { title="Connections" description="Connections between your product and your usersโ€™ accounts on third-party software." /> -
+
+ <> diff --git a/apps/client-ts/src/components/Configuration/AddAuthCredentials.tsx b/apps/client-ts/src/components/Configuration/AddAuthCredentials.tsx index de02cc4ab..572aa41c2 100644 --- a/apps/client-ts/src/components/Configuration/AddAuthCredentials.tsx +++ b/apps/client-ts/src/components/Configuration/AddAuthCredentials.tsx @@ -44,7 +44,7 @@ const AddAuthCredentials = () => { }} > - Add 0Auth Credentials + Add Custom OAuth diff --git a/apps/client-ts/src/components/Configuration/AddAuthCredentialsForm.tsx b/apps/client-ts/src/components/Configuration/AddAuthCredentialsForm.tsx index 99f49ba26..51355a356 100644 --- a/apps/client-ts/src/components/Configuration/AddAuthCredentialsForm.tsx +++ b/apps/client-ts/src/components/Configuration/AddAuthCredentialsForm.tsx @@ -220,7 +220,7 @@ const AddAuthCredentialsForm = (prop : propType) => { attributes:["client_id","client_secret","scope"], values:[client_id,client_secret,scope] }) - posthog?.capture("Connection_strategy_0Auth2_updated", { + posthog?.capture("Connection_strategy_OAuth2_updated", { id_project: idProject, mode: config.DISTRIBUTION }); @@ -233,7 +233,7 @@ const AddAuthCredentialsForm = (prop : propType) => { attributes:["client_id","client_secret","scope"], values:[client_id,client_secret,scope] }); - posthog?.capture("Connection_strategy_0Auth2_created", { + posthog?.capture("Connection_strategy_OAuth2_created", { id_project: idProject, mode: config.DISTRIBUTION }); @@ -352,9 +352,9 @@ const AddAuthCredentialsForm = (prop : propType) => {
- Add 0Auth Credentials + Add OAuth Credentials - Add your provider' credentials for connection. + In the event that you are using your own OAuth credentials, Panora gives you have the option to import them instead of using our pre-made OAuth apps. @@ -461,7 +461,7 @@ const AddAuthCredentialsForm = (prop : propType) => { - 0Auth2 + OAuth2 API Basic Auth @@ -474,7 +474,7 @@ const AddAuthCredentialsForm = (prop : propType) => { - {/* If Authentication Method is 0Auth2 */} + {/* If Authentication Method is OAuth2 */} {Watch.auth_type===AuthStrategy.oauth2 ? <> @@ -607,7 +607,7 @@ const AddAuthCredentialsForm = (prop : propType) => { <>} - +
diff --git a/apps/client-ts/src/components/Configuration/AddWebhook.tsx b/apps/client-ts/src/components/Configuration/AddWebhook.tsx index 46cfa4614..9737bd9b0 100644 --- a/apps/client-ts/src/components/Configuration/AddWebhook.tsx +++ b/apps/client-ts/src/components/Configuration/AddWebhook.tsx @@ -116,9 +116,9 @@ const AddWebhook = () => {
- Define your webhook + Create a webhook - React to specific events in your product. + Set up your webhook endpoint to receive live events from Panora. @@ -160,15 +160,14 @@ const AddWebhook = () => { name="url" render={({ field }) => ( - Destination URL + Endpoint URL - This is the endpoint where the webhook will send requests to. @@ -184,13 +183,10 @@ const AddWebhook = () => { Description - - This is the description of your webhook. - )} @@ -198,7 +194,7 @@ const AddWebhook = () => { - +
diff --git a/apps/client-ts/src/components/Configuration/FieldMappingModal.tsx b/apps/client-ts/src/components/Configuration/FieldMappingModal.tsx index 793f5124e..ae730fccf 100644 --- a/apps/client-ts/src/components/Configuration/FieldMappingModal.tsx +++ b/apps/client-ts/src/components/Configuration/FieldMappingModal.tsx @@ -155,17 +155,18 @@ export function FModal({ onClose }: {onClose: () => void}) { return ( - Define Field - Map Fields + Create Field + Map Field
- Define Panora Field + Create a custom field - Define a Panora custom field to extend a unified model. Once done, you can map it to an existing field in your end-user's software. + Create a custom field in Panora to extend our unified objects. Once done, you can map this field to existing fields in your end-user's software. Find details in + documentation. @@ -175,7 +176,7 @@ export function FModal({ onClose }: {onClose: () => void}) { name="standardModel" render={({ field }) => ( - Standard Object + What object to you want to extend? - - This is the common unified model (Contact, Company, Ticket...) - )} @@ -206,16 +204,13 @@ export function FModal({ onClose }: {onClose: () => void}) { name="fieldName" render={({ field }) => ( - Name + Give your Custom Field an identifier - - This will be the name of the field on Panora's side. - )} @@ -234,9 +229,6 @@ export function FModal({ onClose }: {onClose: () => void}) { className="flex h-10 w-full rounded-md border border-input bg-background px-3 py-2 text-sm ring-offset-background file:border-0 file:bg-transparent file:text-sm file:font-medium placeholder:text-muted-foreground focus-visible:outline-none focus-visible:ring-ring focus-visible:ring-offset-2 disabled:cursor-not-allowed disabled:opacity-50" /> - - A quick description of the field to remind you its context. - )} @@ -248,7 +240,7 @@ export function FModal({ onClose }: {onClose: () => void}) { name="fieldType" render={({ field }) => ( - Field Type + Data Type - - This is the type of the field. - )} @@ -277,7 +266,7 @@ export function FModal({ onClose }: {onClose: () => void}) { - +
@@ -289,9 +278,9 @@ export function FModal({ onClose }: {onClose: () => void}) {
- Map + Map Field - After you defined a Panora custom field, you can map it to an existent custom field on your end-user's software. + Field Mapping allows you to map data from your users' platforms to custom fields on your Panora Unified Models. @@ -301,7 +290,7 @@ export function FModal({ onClose }: {onClose: () => void}) { name="attributeId" render={({ field }) => ( - Panora Field + Panora Custom Field - - This is the field name that you defined. - )} diff --git a/apps/client-ts/src/components/Connection/AddConnectionButton.tsx b/apps/client-ts/src/components/Connection/AddConnectionButton.tsx index 2af2a74ab..341b18e51 100644 --- a/apps/client-ts/src/components/Connection/AddConnectionButton.tsx +++ b/apps/client-ts/src/components/Connection/AddConnectionButton.tsx @@ -192,7 +192,7 @@ const AddConnectionButton = ({ Share this magic link with your customers - {showNewLinkedUserDialog.import ? "You can upload a sheet of your existing customers" : "Generate a unique link for your customer"} + {showNewLinkedUserDialog.import ? "You can upload a sheet of your existing customers" : "Panora's Magic Link allows you to deliver an in-browser Panora Link experience and let users grant you access to their account. Send your users secure URLs to authorize their integrations in production without frontend code."} @@ -210,12 +210,12 @@ const AddConnectionButton = ({ Origin User Identifier - This is the id of the user in your system. + Uniquely identifies Linked Accounts. An end-user should have one for each third-party account connected. @@ -231,12 +231,12 @@ const AddConnectionButton = ({ Origin User Email - This is the email of the user in your system. + For identification purposes โ€” we will not send anything. @@ -260,7 +260,7 @@ const AddConnectionButton = ({ Cancel - + diff --git a/apps/client-ts/src/components/Nav/main-nav.tsx b/apps/client-ts/src/components/Nav/main-nav.tsx index 913a06b28..e26ed860c 100644 --- a/apps/client-ts/src/components/Nav/main-nav.tsx +++ b/apps/client-ts/src/components/Nav/main-nav.tsx @@ -62,9 +62,9 @@ export function MainNav({ target="_blank" rel="noopener noreferrer" > -

Docs

+

Documentation

); -} +} \ No newline at end of file diff --git a/apps/client-ts/src/components/RootLayout/index.tsx b/apps/client-ts/src/components/RootLayout/index.tsx index 2899a6641..7e69f5f35 100644 --- a/apps/client-ts/src/components/RootLayout/index.tsx +++ b/apps/client-ts/src/components/RootLayout/index.tsx @@ -41,15 +41,13 @@ export const RootLayout = ({children}:{children:React.ReactNode}) => { } }; - return ( <>
-
{children}
diff --git a/docs/welcome.mdx b/docs/welcome.mdx index f8124075a..513616c75 100644 --- a/docs/welcome.mdx +++ b/docs/welcome.mdx @@ -3,16 +3,6 @@ title: ๐ŸŒผ Welcome to Panora description: "Panora is an open-source, unified API for shipping customer-facing integrations" --- -Hero Light - -- Have you ever met anyone who loves building integrations? -- *No.* -- We're building Panora to save you from that - -- **Simple developer experience:** easy to self-host, uses industry-standard data models, and is extensible -- **Builder-friendly terms:** Panora is open-source, and offers generous tips for contributors - - ### ๐Ÿ”ฎ Core Features | | @@ -50,16 +36,6 @@ description: "Panora is an open-source, unified API for shipping customer-facing | **Flexible Sync Settings:** Businesses that need real-time update can configure Panora accordingly | | **Webhooks:** Listen to one webhook to receive normalized data from various software platforms | - -### ๐Ÿค Core Values - -| | -|-------------------------------------------| -| ๐Ÿ’ป Easy Developer Experience | -| ๐Ÿซก Fair Value Share: Contributors are valuable, so we've decided to let our community tip our heroes | - - - [โœ๏ธ Suggest an update](https://tally.so/r/mRD1QQ?feedback_source=welcome) diff --git a/packages/api/swagger/swagger-spec.json b/packages/api/swagger/swagger-spec.json index c00c2d20a..44f7aa6ab 100644 --- a/packages/api/swagger/swagger-spec.json +++ b/packages/api/swagger/swagger-spec.json @@ -83,31 +83,6 @@ ] } }, - "/auth/users/create": { - "post": { - "operationId": "createUser", - "summary": "Create User", - "parameters": [], - "requestBody": { - "required": true, - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/CreateUserDto" - } - } - } - }, - "responses": { - "201": { - "description": "" - } - }, - "tags": [ - "auth" - ] - } - }, "/auth/login": { "post": { "operationId": "signIn", @@ -425,7 +400,7 @@ ] } }, - "/linked-users/create": { + "/linked-users": { "post": { "operationId": "addLinkedUser", "summary": "Add Linked User", @@ -448,9 +423,7 @@ "tags": [ "linked-users" ] - } - }, - "/linked-users": { + }, "get": { "operationId": "getLinkedUsers", "summary": "Retrieve Linked Users", @@ -542,9 +515,7 @@ "tags": [ "projects" ] - } - }, - "/projects/create": { + }, "post": { "operationId": "createProject", "summary": "Create a project", @@ -569,7 +540,7 @@ ] } }, - "/field-mapping/entities": { + "/field-mappings/entities": { "get": { "operationId": "getFieldMappingsEntities", "summary": "Retrieve field mapping entities", @@ -580,11 +551,11 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, - "/field-mapping/attribute": { + "/field-mappings/attribute": { "get": { "operationId": "getFieldMappings", "summary": "Retrieve field mappings", @@ -595,11 +566,11 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, - "/field-mapping/value": { + "/field-mappings/value": { "get": { "operationId": "getFieldMappingValues", "summary": "Retrieve field mappings values", @@ -610,11 +581,11 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, - "/field-mapping/define": { + "/field-mappings/define": { "post": { "operationId": "defineTargetField", "summary": "Define target Field", @@ -635,11 +606,11 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, - "/field-mapping/map": { + "/field-mappings/map": { "post": { "operationId": "mapField", "summary": "Map Custom Field", @@ -660,11 +631,11 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, - "/field-mapping/properties": { + "/field-mappings/properties": { "get": { "operationId": "getCustomProviderProperties", "summary": "Retrieve Custom Properties", @@ -700,7 +671,7 @@ } }, "tags": [ - "field-mapping" + "field-mappings" ] } }, @@ -762,7 +733,7 @@ ] } }, - "/magic-link/create": { + "/magic-links": { "post": { "operationId": "createMagicLink", "summary": "Create a Magic Link", @@ -783,11 +754,9 @@ } }, "tags": [ - "magic-link" + "magic-links" ] - } - }, - "/magic-link": { + }, "get": { "operationId": "getMagicLinks", "summary": "Retrieve Magic Links", @@ -798,11 +767,11 @@ } }, "tags": [ - "magic-link" + "magic-links" ] } }, - "/magic-link/single": { + "/magic-links/single": { "get": { "operationId": "getMagicLink", "summary": "Retrieve a Magic Link", @@ -822,7 +791,7 @@ } }, "tags": [ - "magic-link" + "magic-links" ] } }, @@ -1065,7 +1034,7 @@ ] } }, - "/sync/status/{vertical}": { + "/syncs/status/{vertical}": { "get": { "operationId": "getSyncStatus", "summary": "Retrieve sync status of a certain vertical", @@ -1085,11 +1054,11 @@ } }, "tags": [ - "sync" + "syncs" ] } }, - "/sync/resync/{vertical}": { + "/syncs/resyncs/{vertical}": { "get": { "operationId": "resync", "summary": "Resync common objects across a vertical", @@ -1109,7 +1078,7 @@ } }, "tags": [ - "sync" + "syncs" ] } }, @@ -3141,7 +3110,7 @@ ] } }, - "/ticketing/collection": { + "/ticketing/collections": { "get": { "operationId": "getCollections", "summary": "List a batch of Collections", @@ -3189,11 +3158,11 @@ } }, "tags": [ - "ticketing/collection" + "ticketing/collections" ] } }, - "/ticketing/collection/{id}": { + "/ticketing/collections/{id}": { "get": { "operationId": "getCollection", "summary": "Retrieve a Collection", @@ -3242,7 +3211,7 @@ } }, "tags": [ - "ticketing/collection" + "ticketing/collections" ] } }, diff --git a/packages/api/variables.MD b/packages/api/variables.MD new file mode 100644 index 000000000..cd4ee89f4 --- /dev/null +++ b/packages/api/variables.MD @@ -0,0 +1,6 @@ +| Variable Name | Description | Example Value | Required at Build | +|--------------------|--------------------------------------------|---------------|------------------| +| DATABASE_URL | URL for connecting to the PostgreSQL database | | | +| DOPPLER_CONFIG | Configuration identifier for Doppler | prd | | +| DOPPLER_ENVIRONMENT | Environment identifier for Doppler | prd | | +| DOPPLER_PROJECT | Project identifier for Doppler | backend | |