fix: Get the name of the board

[shanaya-Gupta]

Fix for Issue #55

Issue: Get the name of the board

Changes:

• Modified: internal/api/api.go, internal/api/docs/openapi.yaml

Please review carefully before merging.

[CLAassistant]

Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
_{You have signed the CLA already but the status is still pending? Let us recheck it.}

[alessio-perugini]

It might be better to use a more generic endpoint like /v1/system/information.
This would make the API more cohesive and easier to extend in the future if new properties are added that still fall under the general “information” category.

If you only need to retrieve the system name, you could either include a query parameter filter (e.g. ?filter=name) or use a more specific endpoint such as /v1/system/information/name.

[alessio-perugini]

the openapi.yaml file is generated from cmd/gendoc/docs.go file.

You have to add your definition programmatically.

You can take inspiration from:

arduino-app-cli/cmd/gendoc/docs.go

Lines 795 to 825 in 5a33829

	'data: {"code":"INTERNAL_SERVER_ERROR","message":"An error occurred during operation"}'
	`,
	},
	Description: "Returns the system resources usage, such as memory, disk and CPU.",
	Summary: "Get system resources usage",
	Tags: []Tag{SystemTag},
	PossibleErrors: []ErrorResponse{
	{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
	},
	},
	{
	OperationId: "checkUpdate",
	Method: http.MethodGet,
	Path: "/v1/system/update/check",
	Parameters: (*struct {
	OnlyArduino bool `query:"only-arduino" description:"If true, check only for Arduino packages that require an upgrade. Default is false."`
	})(nil),
	CustomSuccessResponse: &CustomResponseDef{
	ContentType: "application/json",
	DataStructure: handlers.UpdateCheckResult{},
	Description: "Successful response",
	StatusCode: http.StatusOK,
	},
	Description: "Returns the details of packages to be upgraded.",
	Summary: "Get the packages that requires an upgrade",
	Tags: []Tag{SystemTag},
	PossibleErrors: []ErrorResponse{
	{StatusCode: http.StatusInternalServerError, Reference: "#/components/responses/InternalServerError"},
	{StatusCode: http.StatusBadRequest, Reference: "#/components/responses/BadRequest"},
	{StatusCode: http.StatusNoContent, Reference: "#/components/responses/NoContent"},
	},

[alessio-perugini]

@lucarin91 perhaps would be better to go back to spec first approach, to ease future contributions?