[HTTP/OAS] Add descriptions for short URL APIs (elastic#184267)

kapral18 · May 27, 2024 · a79edf1 · a79edf1
1 parent 099e79a
commit a79edf1
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/src/plugins/share/server/url_service/http/short_urls/register_create_route.ts b/src/plugins/share/server/url_service/http/short_urls/register_create_route.ts
@@ -15,6 +15,10 @@ export const registerCreateRoute = (router: IRouter, url: ServerUrlService) => {
   router.post(
     {
       path: '/api/short_url',
+      options: {
+        access: 'public',
+        description: `Create a short URL`,
+      },
       validate: {
         body: schema.object({
           locatorId: schema.string({

diff --git a/src/plugins/share/server/url_service/http/short_urls/register_delete_route.ts b/src/plugins/share/server/url_service/http/short_urls/register_delete_route.ts
@@ -14,6 +14,10 @@ export const registerDeleteRoute = (router: IRouter, url: ServerUrlService) => {
   router.delete(
     {
       path: '/api/short_url/{id}',
+      options: {
+        access: 'public',
+        description: `Delete a short URL`,
+      },
       validate: {
         params: schema.object({
           id: schema.string({

diff --git a/src/plugins/share/server/url_service/http/short_urls/register_get_route.ts b/src/plugins/share/server/url_service/http/short_urls/register_get_route.ts
@@ -14,6 +14,10 @@ export const registerGetRoute = (router: IRouter, url: ServerUrlService) => {
   router.get(
     {
       path: '/api/short_url/{id}',
+      options: {
+        access: 'public',
+        description: `Get a short URL`,
+      },
       validate: {
         params: schema.object({
           id: schema.string({

diff --git a/src/plugins/share/server/url_service/http/short_urls/register_resolve_route.ts b/src/plugins/share/server/url_service/http/short_urls/register_resolve_route.ts
@@ -15,6 +15,10 @@ export const registerResolveRoute = (router: IRouter, url: ServerUrlService) =>
   router.get(
     {
       path: '/api/short_url/_slug/{slug}',
+      options: {
+        access: 'public',
+        description: `Resolve a short URL`,
+      },
       validate: {
         params: schema.object({
           slug: schema.string({