From 6bd553dedb2477125e1628f22a1fe0cc4ddc1811 Mon Sep 17 00:00:00 2001 From: elhmn Date: Sun, 28 May 2023 20:44:29 +0200 Subject: [PATCH] backend: rename docs folder to swagger --- backend/main.go | 2 +- backend/{docs => swagger}/cities.go | 2 +- backend/{docs => swagger}/companies.go | 2 +- backend/{docs => swagger}/company_ratings.go | 2 +- backend/{docs => swagger}/health.go | 2 +- backend/{docs => swagger}/jobtitles.go | 2 +- backend/{docs => swagger}/ratings.go | 2 +- backend/{docs => swagger}/salaries.go | 2 +- backend/{docs => swagger}/seniority.go | 2 +- backend/{docs/docs.go => swagger/swagger.go} | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) rename backend/{docs => swagger}/cities.go (96%) rename backend/{docs => swagger}/companies.go (98%) rename backend/{docs => swagger}/company_ratings.go (98%) rename backend/{docs => swagger}/health.go (95%) rename backend/{docs => swagger}/jobtitles.go (97%) rename backend/{docs => swagger}/ratings.go (99%) rename backend/{docs => swagger}/salaries.go (98%) rename backend/{docs => swagger}/seniority.go (96%) rename backend/{docs/docs.go => swagger/swagger.go} (95%) diff --git a/backend/main.go b/backend/main.go index 85f828d..bb02250 100644 --- a/backend/main.go +++ b/backend/main.go @@ -3,8 +3,8 @@ package main import ( "github.com/gin-contrib/cors" "github.com/gin-gonic/gin" - _ "github.com/osscameroon/jobsika/docs" "github.com/osscameroon/jobsika/internal/handlers" + _ "github.com/osscameroon/jobsika/swagger" ) func main() { diff --git a/backend/docs/cities.go b/backend/swagger/cities.go similarity index 96% rename from backend/docs/cities.go rename to backend/swagger/cities.go index 6330314..d5a40f7 100644 --- a/backend/docs/cities.go +++ b/backend/swagger/cities.go @@ -1,4 +1,4 @@ -package docs +package swagger // swagger:route GET /cities cities idOfCities // Companies returns cities endpoint diff --git a/backend/docs/companies.go b/backend/swagger/companies.go similarity index 98% rename from backend/docs/companies.go rename to backend/swagger/companies.go index 1e8e913..7f69261 100644 --- a/backend/docs/companies.go +++ b/backend/swagger/companies.go @@ -1,4 +1,4 @@ -package docs +package swagger import ( "github.com/osscameroon/jobsika/pkg/models/v1beta" diff --git a/backend/docs/company_ratings.go b/backend/swagger/company_ratings.go similarity index 98% rename from backend/docs/company_ratings.go rename to backend/swagger/company_ratings.go index f4b24a3..d22fd80 100644 --- a/backend/docs/company_ratings.go +++ b/backend/swagger/company_ratings.go @@ -1,4 +1,4 @@ -package docs +package swagger import ( "github.com/osscameroon/jobsika/pkg/models/v1beta" diff --git a/backend/docs/health.go b/backend/swagger/health.go similarity index 95% rename from backend/docs/health.go rename to backend/swagger/health.go index 6c84fae..1e2eb19 100644 --- a/backend/docs/health.go +++ b/backend/swagger/health.go @@ -1,4 +1,4 @@ -package docs +package swagger // swagger:route GET /health health idOfHealth // Companies returns health endpoint diff --git a/backend/docs/jobtitles.go b/backend/swagger/jobtitles.go similarity index 97% rename from backend/docs/jobtitles.go rename to backend/swagger/jobtitles.go index e27cb80..6ea55a6 100644 --- a/backend/docs/jobtitles.go +++ b/backend/swagger/jobtitles.go @@ -1,4 +1,4 @@ -package docs +package swagger // swagger:route GET /jobtitles jobtitles idOfCompanyWithoutID // Companies returns the list of jobtitles diff --git a/backend/docs/ratings.go b/backend/swagger/ratings.go similarity index 99% rename from backend/docs/ratings.go rename to backend/swagger/ratings.go index db2b685..5380a89 100644 --- a/backend/docs/ratings.go +++ b/backend/swagger/ratings.go @@ -1,4 +1,4 @@ -package docs +package swagger import ( "github.com/osscameroon/jobsika/pkg/models/v1beta" diff --git a/backend/docs/salaries.go b/backend/swagger/salaries.go similarity index 98% rename from backend/docs/salaries.go rename to backend/swagger/salaries.go index 1c4dc45..7940feb 100644 --- a/backend/docs/salaries.go +++ b/backend/swagger/salaries.go @@ -1,4 +1,4 @@ -package docs +package swagger import ( "github.com/osscameroon/jobsika/pkg/models/v1beta" diff --git a/backend/docs/seniority.go b/backend/swagger/seniority.go similarity index 96% rename from backend/docs/seniority.go rename to backend/swagger/seniority.go index 018b50b..8d46e7e 100644 --- a/backend/docs/seniority.go +++ b/backend/swagger/seniority.go @@ -1,4 +1,4 @@ -package docs +package swagger // swagger:route GET /seniority seniority idOfSeniority // Companies returns seniority endpoint diff --git a/backend/docs/docs.go b/backend/swagger/swagger.go similarity index 95% rename from backend/docs/docs.go rename to backend/swagger/swagger.go index 437fe57..bb36f19 100644 --- a/backend/docs/docs.go +++ b/backend/swagger/swagger.go @@ -14,4 +14,4 @@ // - application/json // // swagger:meta -package docs +package swagger