Explorar o código

Update Documentation for URLS

Savio Fernando hai 1 ano
pai
achega
6430e230e3
Modificáronse 1 ficheiros con 17 adicións e 1 borrados
  1. 17 1
      src/api/urls.js

+ 17 - 1
src/api/urls.js

@@ -5,16 +5,32 @@ export const API_URL_v1 = BASE_URL + "/api/v1/"
 export const API_URL_v2 = BASE_URL + "/api/v2/"
 
 
-
 // * V1 API URLS
+
+/** @constant {String} */
 export const ARTICLE_URL = `article/search/?domain=${DEFAULT_DOMAIN}`
+
+/** @constant {String} */
 export const TRENDING_URL = `trending/?domain=${DEFAULT_DOMAIN}`
+
+/** @constant {String} */
 export const MENUS_URL =  `menus/?domain=${DEFAULT_DOMAIN}`
+
+/** @constant {String} */
 export const ARTICLE_CATEGORY_URL = (category_type,page = 1) =>  `article/search/?domain=${DEFAULT_DOMAIN}&category=${category_type}&page=${page}`
+
+/** @constant {String} */
 export const ARTICLE_SEARCH_URL = (search_text,page = 1,filters="") =>  `article/search/?domain=${DEFAULT_DOMAIN}&q=${search_text}&page=${page}${filters}`
+
+/** @constant {String} */
 export const ARTICLE_DETAIL_URL = (slug) => `articles/${slug}/?domain=${DEFAULT_DOMAIN}`
+
+/** @constant {String} */
 export const ARTICLE_COMMENTS_URL = (id) => `comment/?article_id=${id}`
+
+/** @constant {String} */
 export const ARTICLE_RECOMMENDATIONS_URL = (id) => `articles/${id}/recommendations`
 
 // * V1 Linking URLS
+/** @constant {String} */
 export const NEWSCOUT_NEWS_URL = (slug) => `${BASE_URL}/news/article/${slug}`