6434438023/oph24 8 documentation swagger #11

Wer1d · 2023-12-25T18:43:58Z

เขียน swagger ของ event , healthcheck and livestreamFlag

linear · 2023-12-25T18:44:01Z

ImSoZRious · 2023-12-25T19:10:19Z

do a git pull origin beta and resolve the conflict. If you're not sure which one is correct, you can see the code from beta branch.

ImSoZRious

please rebase on origin/beta. I can't read what you've written because code pr is mixed with other.

ImSoZRious · 2023-12-25T19:12:09Z

cmd/main.go

+	r.GET("/live", container.FeatureflagHandler.GetLivestreamInfo)
+	r.GET("/events", container.EventHandler.GetAllEvents)
+	r.GET("/events/:eventId", container.EventHandler.GetEventById)
+	r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))


Check for env it is deployed in

if container.Config.AppConfig.Env != "development" { r.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) }

ImSoZRious · 2023-12-25T19:12:56Z

cmd/main.go

+// @title           OPH-66 Backend API
+// @version         1.0
+// @description     This is a sample server celler server.
+// @securityDefinitions.basic  BasicAuth


We use BearerAuth not BasicAuth

ImSoZRious · 2023-12-25T19:13:07Z

cmd/main.go

 )

+// @title           OPH-66 Backend API
+// @version         1.0
+// @description     This is a sample server celler server.


Make it little more meaningful.

ImSoZRious · 2023-12-25T19:13:20Z

cmd/main.go


+	fmt.Println(container.Config.AppConfig.Port)


Remove this debug

ImSoZRious · 2023-12-25T19:18:10Z

swaggerModel/response/feature_flag.response.go

+package response
+
+type featureFlagResponse struct {
+	Key    string `json:"key" example:"livestream"`
+	Enabled bool `json:"enabled" example:"true"`
+	ExtraInfo string `json:"extra_info" example:"https://www.youtube.com/watch?v=6n3pFFPSlW4"`
+}
+
+type featureFlagErrorResponse struct {
+	Instance string `json:"instance" example:"/featureflag/live"`	
+	Title    string `json:"title" example:"internal-server-error"`
+}
+
+type featureFlagInvalidResponse struct {
+	Instance string `json:"instance" example:"/featureflag/live"`
+	Title    string `json:"title" example:"invalid-feature-flag-key"`
+}


I think it would be more appropiate to put this in each /internal/X. For example,

// internal/feature_flag/feature_flag.dto.go type featureFlagResponse struct { Key string `json:"key" example:"livestream"` Enabled bool `json:"enabled" example:"true"` ExtraInfo string `json:"extra_info" example:"https://www.youtube.com/watch?v=6n3pFFPSlW4"` } type featureFlagErrorResponse struct { Instance string `json:"instance" example:"/featureflag/live"` Title string `json:"title" example:"internal-server-error"` } type featureFlagInvalidResponse struct { Instance string `json:"instance" example:"/featureflag/live"` Title string `json:"title" example:"invalid-feature-flag-key"` }

ImSoZRious · 2023-12-25T19:28:05Z

This is roughly your git branch situation

gitGraph
    commit
    commit
    branch develop
    checkout main
    commit id: "feat: event"
    checkout develop
    merge main
    commit
    checkout main
    commit id: "fix: featureflag"
    checkout develop
    merge main
    commit
    commit
    commit
    checkout main
    merge develop

You can see that from you branch perspective, you have commit other code as well.

To fix this (not easy tho), you need to rebase your code on origin beta

git rebase -i origin beta

then resolve every conflict

after that your git history should look like this

gitGraph
    commit
    commit
    checkout main
    commit id: "feat: event"
    commit id: "fix: featureflag"
    branch develop
    commit
    commit
    commit
    commit
    checkout main
    merge develop

To prevent this from happening again you can do

git config --global pull.rebase true

ref

ImSoZRious

please rebase on origin/beta. I can't read what you've written because code pr is mixed with other.

ImSoZRious · 2023-12-26T08:42:58Z

cfgldr/cfgldr.go

@@ -26,6 +26,7 @@ type RedisConfig struct {
 }

 func LoadConfig() (*Config, error) {
+


Suggested change

ImSoZRious · 2023-12-26T08:43:23Z

.env.example

-DB_URL=postgres://postgres:[email protected]:5432/postgres
-
-REDIS_ADDR=127.0.0.1
-REDIS_PORT=6379
-REDIS_PASSWORD=123456
-
-APP_PORT=3000
-APP_ENV=development


Bring back .env.example

ImSoZRious · 2023-12-26T08:44:05Z

internal/event/event.dto.go

+type eventInvalidResponse struct {
+	Instance string `json:"instance" example:"/events/:eventId"`
+	Title    string `json:"title" example:"invalid-event-id"`
+}


Suggested change

type eventInvalidResponse struct {

Instance string `json:"instance" example:"/events/:eventId"`

Title string `json:"title" example:"invalid-event-id"`

}

//nolint:all

type EventInvalidResponse struct {

Instance string `json:"instance" example:"/events/:eventId"`

Title string `json:"title" example:"invalid-event-id"`

}

ImSoZRious · 2023-12-26T08:44:54Z

internal/event/event.dto.go

+type eventErrorResponse struct {
+	Instance string `json:"instance" example:"/events/:eventId"`
+	Title    string `json:"title" example:"internal-server-error"`
+}


Suggested change

type eventErrorResponse struct {

Instance string `json:"instance" example:"/events/:eventId"`

Title string `json:"title" example:"internal-server-error"`

}

//nolint:all

type EventErrorResponse struct {

Instance string `json:"instance" example:"/events/:eventId"`

Title string `json:"title" example:"internal-server-error"`

}

ImSoZRious · 2023-12-26T08:45:29Z

internal/event/event.dto.go

+type EventDTO struct {
+	Id                  string               `json:"id" example:"first-event"`
+	Name                NameEventBilingual   `json:"name" `
+	FacultyCode         int                  `json:"-" `
+	Faculty             Faculty              `json:"faculty"`
+	Department          DepartmentBilingual  `json:"department" `
+	RequireRegistration bool                 `json:"require_registration" example:"true"`
+	MaxCapacity         int                  `json:"max_capacity" example:"100"`
+	Schedules           []Schedule           `json:"schedules" `
+	Location            LocationBilingual    `json:"location"`
+	Description         DescriptionBilingual `json:"description,omitempty"`
+}


Suggested change

type EventDTO struct {

Id string `json:"id" example:"first-event"`

Name NameEventBilingual `json:"name" `

FacultyCode int `json:"-" `

Faculty Faculty `json:"faculty"`

Department DepartmentBilingual `json:"department" `

RequireRegistration bool `json:"require_registration" example:"true"`

MaxCapacity int `json:"max_capacity" example:"100"`

Schedules []Schedule `json:"schedules" `

Location LocationBilingual `json:"location"`

Description DescriptionBilingual `json:"description,omitempty"`

}

type EventDTO struct {

Id string `json:"id" example:"first-event"`

Name NameEventBilingual `json:"name"`

FacultyCode int `json:"-"`

Faculty Faculty `json:"faculty"`

Department DepartmentBilingual `json:"department"`

RequireRegistration bool `json:"require_registration" example:"true"`

MaxCapacity int `json:"max_capacity" example:"100"`

Schedules []Schedule `json:"schedules"`

Location LocationBilingual `json:"location"`

Description DescriptionBilingual `json:"description,omitempty"`

}

ImSoZRious · 2023-12-26T08:51:53Z

internal/event/event.handler.go

+// GetAllEvents godoc
+//	@summary		Get all events
+//	@description	Get all events as array of events
+//	@id				GetAllEvents
+//	@produce		json
+//	@tags			event
+//	@Security		Bearer
+//	@router			/events [get]
+//	@success		200	{object}	event.EventAll
+//	@Failure		500	{object}	event.eventAllErrorResponse
+//	@Failure		404	{object}	event.eventInvalidResponse


Suggested change

// GetAllEvents godoc

// @summary Get all events

// @description Get all events as array of events

// @id GetAllEvents

// @produce json

// @tags event

// @Security Bearer

// @router /events [get]

// @success 200 {object} event.EventAll

// @Failure 500 {object} event.eventAllErrorResponse

// @Failure 404 {object} event.eventInvalidResponse

// GetAllEvents godoc

// @summary Get all events

// @description Get all events as array of events

// @id GetAllEvents

// @produce json

// @tags event

// @Security Bearer

// @router /events [get]

// @success 200 {object} event.EventAll

// @Failure 500 {object} event.eventAllErrorResponse

// @Failure 404 {object} event.eventInvalidResponse

ImSoZRious · 2023-12-26T08:53:11Z

internal/event/event.handler.go

+// GetEvent godoc
+//	@summary		get event by id
+//	@description	Get event by id
+//	@id				GetEventById
+//	@produce		json
+//	@tags			event
+//	@Security		Bearer
+//	@param			eventId	path	string	true	"event id"
+//	@router			/events/{eventId} [get]
+//	@success		200	{object}	event.EventDTO
+//	@Failure		500	{object}	event.eventErrorResponse
+//	@Failure		404	{object}	event.eventInvalidResponse


Suggested change

// GetEvent godoc

// @summary get event by id

// @description Get event by id

// @id GetEventById

// @produce json

// @tags event

// @Security Bearer

// @param eventId path string true "event id"

// @router /events/{eventId} [get]

// @success 200 {object} event.EventDTO

// @Failure 500 {object} event.eventErrorResponse

// @Failure 404 {object} event.eventInvalidResponse

// GetEvent godoc

// @summary get event by id

// @description Get event by id

// @id GetEventById

// @produce json

// @tags event

// @Security Bearer

// @param eventId path string true "event id"

// @router /events/{eventId} [get]

// @success 200 {object} event.EventDTO

// @Failure 500 {object} event.eventErrorResponse

// @Failure 404 {object} event.eventInvalidResponse

ImSoZRious · 2023-12-26T08:54:49Z

internal/feature_flag/feature_flag.handler.go

+// GetLivestreamInfo godoc
+//	@summary		Get livestream flag
+//	@description	Get livestream flag
+//	@id				GetLivestreamInfo
+//	@produce		json
+//	@tags			LiveStream
+//	@Security		Bearer
+//	@router			/live [get]
+//	@success		200	{object}	featureflag.response
+//	@Failure		500	{object}	featureflag.errorResponse
+//	@Failure		404	{object}	featureflag.invalidResponse


Suggested change

// GetLivestreamInfo godoc

// @summary Get livestream flag

// @description Get livestream flag

// @id GetLivestreamInfo

// @produce json

// @tags LiveStream

// @Security Bearer

// @router /live [get]

// @success 200 {object} featureflag.response

// @Failure 500 {object} featureflag.errorResponse

// @Failure 404 {object} featureflag.invalidResponse

// GetLivestreamInfo godoc

// @summary Get livestream flag

// @description Get livestream flag

// @id GetLivestreamInfo

// @produce json

// @tags FeatureFlag

// @Security Bearer

// @router /live [get]

// @success 200 {object} featureflag.response

// @Failure 500 {object} featureflag.errorResponse

// @Failure 404 {object} featureflag.invalidResponse

ImSoZRious · 2023-12-26T08:55:25Z

internal/feature_flag/feature_flag.dto.go

+type response struct {
+	Key    string `json:"key" example:"livestream"`
+	Enabled bool `json:"enabled" example:"true"`
+	ExtraInfo string `json:"extra_info" example:"https://www.youtube.com/watch?v=6n3pFFPSlW4"`
+}


Suggested change

type response struct {

Key string `json:"key" example:"livestream"`

Enabled bool `json:"enabled" example:"true"`

ExtraInfo string `json:"extra_info" example:"https://www.youtube.com/watch?v=6n3pFFPSlW4"`

}

type response struct {

Key string `json:"key" example:"livestream"`

Enabled bool `json:"enabled" example:"true"`

ExtraInfo string `json:"extra_info" example:"https://www.youtube.com/watch?v=6n3pFFPSlW4"`

}

ImSoZRious · 2023-12-26T08:56:12Z

internal/health_check/health_check.handler.go

+// HealthCheck godoc
+//	@summary		Health Check
+//	@description	Health Check for the service
+//	@id				HealthCheck
+//	@produce		plain
+//	@tags			healthcheck
+//	@Security		Bearer
+//	@router			/_hc [get]
+//	@Success		200	{string}	string	"OK"


Suggested change

// HealthCheck godoc

// @summary Health Check

// @description Health Check for the service

// @id HealthCheck

// @produce plain

// @tags healthcheck

// @Security Bearer

// @router /_hc [get]

// @Success 200 {string} string "OK"

// HealthCheck godoc

// @summary Health Check

// @description Health Check for the service

// @id HealthCheck

// @produce plain

// @tags healthcheck

// @Security Bearer

// @router /_hc [get]

// @Success 200 {string} string "OK"

ImSoZRious

Also add more doc on new route

parent 3afc3f0 author Wer1d <[email protected]> 1703441246 +0700 committer Wer1d <[email protected]> 1703441246 +0700 refactor: delete godotenv feat : add swagger fix: change BasicAuth to Bearer fix: delete import godotenv docs: auth docs docs: add user-not-found feat: config cors (#15) feat: Register + Login OIDC (#4) * feat: Register + Login OIDC * fix: fix user model * fix: combine login &register, add apperror, normalize database, getUser by header * fix: add atlas migrate, move logic from handler to service, use dto, add logic update * fix: repository, typo, ip/op type * fix: update init sql * refactor: remove migrate.md * fix:typo, config linters * refactor: run lint-fix * fix: normalize round, department, section * fix: model dep and section * refactor:linter-fix * refactor: lint-fix * fix: add fk in init sql, remove update in register, move convert to util file * fix: init sql , remove endpoint, change id to composit key * refactor: auth handler feat: document swagger fix: change BasicAuth to Bearer docs: auth docs docs: all refactor: go mod tidy

ImSoZRious requested changes Dec 25, 2023

View reviewed changes

Wer1d force-pushed the 6434438023/oph24-8-documentation-swagger branch from 76070b0 to 05651f0 Compare December 26, 2023 08:38

ImSoZRious requested changes Dec 26, 2023

View reviewed changes

Wer1d force-pushed the 6434438023/oph24-8-documentation-swagger branch from 05651f0 to 5a8bd3e Compare December 26, 2023 16:54

Wer1d and others added 4 commits December 28, 2023 01:09

fix: lint

9d6032b

chore: remove unused struct

d6a231d

feat: add host config

40a35d9

ImSoZRious force-pushed the 6434438023/oph24-8-documentation-swagger branch from ef848ec to 40a35d9 Compare December 27, 2023 18:39

ImSoZRious approved these changes Dec 27, 2023

View reviewed changes

ImSoZRious merged commit 06522b4 into beta Dec 27, 2023
1 check passed

ImSoZRious deleted the 6434438023/oph24-8-documentation-swagger branch December 27, 2023 18:40

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

6434438023/oph24 8 documentation swagger #11

6434438023/oph24 8 documentation swagger #11

Wer1d commented Dec 25, 2023

linear bot commented Dec 25, 2023

ImSoZRious commented Dec 25, 2023

ImSoZRious left a comment

ImSoZRious Dec 25, 2023

ImSoZRious Dec 25, 2023

ImSoZRious Dec 25, 2023

ImSoZRious Dec 25, 2023

ImSoZRious Dec 25, 2023

ImSoZRious commented Dec 25, 2023

ImSoZRious left a comment

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious Dec 26, 2023

ImSoZRious left a comment

		@@ -26,6 +26,7 @@ type RedisConfig struct {
		}

		func LoadConfig() (*Config, error) {

6434438023/oph24 8 documentation swagger #11

6434438023/oph24 8 documentation swagger #11

Conversation

Wer1d commented Dec 25, 2023

linear bot commented Dec 25, 2023

ImSoZRious commented Dec 25, 2023

ImSoZRious left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ImSoZRious commented Dec 25, 2023

ImSoZRious left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ImSoZRious left a comment

Choose a reason for hiding this comment