package
0.0.0-20241219120101-d8a5f49ad328
Repository: https://github.com/fossology/licensedb.git
Documentation: pkg.go.dev
# Structs
Api contains the information about an endpoint.
APICollection is the object that lists which apis require authentication and which do not.
APICollectionResponse represents the response format for api collection data.
Audit struct represents an audit entity with certain attributes and properties It has user id as a foreign key.
AuditResponse represents the response format for audit data.
ChangeLog struct represents a change entity with certain attributes and properties.
ChangeLogResponse represents the design of API response of change log.
ImportObligationsResponse is the response structure for import obligation response.
ImportObligationsResponse is the response structure for import obligation response.
The LicenseDB struct represents a license entity with various attributes and properties associated with it.
The LicenseError struct represents an error response related to license operations.
LicenseId is the id of successfully imported license.
LicenseImportStatus is the status of license records successfully inserted in the database during import.
No description provided by the author
LicenseMapShortnamesElement Element to hold license shortname and action.
LicenseMapShortnamesInput List of elements to be read as input by API.
LicensePreviewResponse gets us the list of all license shortnames.
LicenseResponse struct is representation of design API response of license.
LicenseShortnamesInput represents the input format for adding/removing licenses from obligation map.
LicenseUpdateJSONSchema struct represents the input format for updating an existing license.
LinksCollection is a collection of links.
Obligation represents an obligation record in the database.
ObligationClassification represents one of the possible of obligation classification values.
ObligationClassificationResponse represents the response format for obligation classification data.
ObligationDTO represents an obligation json object.
ObligationId is the id of successfully imported obligation.
ObligationImportRequest represents the request body structure for import obligation.
ObligationImportStatus is the status of obligation records successfully inserted in the database during import.
ObligationMapResponse response format for obligation map data.
ObligationMapUser Structure with obligation topic and license shortname list, a simple representation for user.
ObligationPreview is just the Type and Topic of Obligation.
ObligationResponse represents the response format for obligation data.
ObligationResponse represents the response format for obligation data.
ObligationType represents one of the possible of obligation type values.
ObligationTypeResponse represents the response format for obligation type data.
ObligationUpdateDTO represents an obligation json object.
The PaginationInput struct represents the input required for pagination.
The PaginationMeta struct represents additional metadata associated with a license retrieval operation.
SearchLicense struct represents the input needed to search in a license.
SwaggerDocAPISecurityScheme is the json schema describing info about various apis.
SwaggerObligationResponse represents the response format for obligation data.
UpdateExternalRefsJSONPayload struct represents the external ref key value pairs for update.
User struct is representation of user information.
No description provided by the author
No description provided by the author
UserResponse struct is representation of design API response of user.
# Interfaces
PaginationParse interface processes the pagination input.
# Type aliases
No description provided by the author