Categorygithub.com/prodyna-yasm/yasm-api-go
repositorypackage
1.42.0
Repository: https://github.com/prodyna-yasm/yasm-api-go.git
Documentation: pkg.go.dev

# Packages

No description provided by the author

# README

Go API client for client

This is an example of using OAuth2 Implicit Flow in a specification to describe security to your API.

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

  • API version: 1.42.0
  • Package version: 1.0.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import client "github.com/prodyna-yasm/yasm-api-go"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), client.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), client.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), client.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), client.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to https://yasm.prodyna.com:443/api/v1

ClassMethodHTTP requestDescription
AvailabilityAPICreateAvailabilityPost /persons/{personId}/availabilitiesCreate a availability for a person
AvailabilityAPIDeleteAvailabilityDelete /persons/{personId}/availabilities/{availabilityId}Delete a person availability
AvailabilityAPIGetAvailabilitiesGet /persons/{personId}/availabilitiesGet a list of all activities for a person
AvailabilityAPIUpdateAvailabilityPut /persons/{personId}/availabilities/{availabilityId}Update a person availability
AwardAPIAddPersonAwardPost /persons/{personId}/awards/{awardId}Add an award to a Person
AwardAPICreateAwardPost /awardsCreate a new Award in an Organization
AwardAPIDeleteAwardDelete /awards/{awardId}Delete an award
AwardAPIDeletePersonAwardDelete /persons/{personId}/awards/{awardId}Remove an Award from a Person
AwardAPIGetAwardGet /awards/{awardId}Get details of an award by ID
AwardAPIMoveAwardPut /awards/{awardId}/organizations/{organizationId}Move an award to an Organization
AwardAPISearchAwardsPost /awards/searchSearch for awards
AwardAPIUpdateAwardPut /awards/{awardId}Update an award
AwardAPIUpdatePersonAwardPut /persons/{personId}/awards/{awardId}Update an Award of a Person
CertificationAPIAddPersonCertificationPost /persons/{personId}/certifications/{certificationId}Add Certification to a Person
CertificationAPIAddSkillToCertificationPost /certifications/{certificationId}/skills/{skillId}
CertificationAPICreateCertificationPost /certificationsCreate a Certification in an Organization
CertificationAPIDeleteCertificationDelete /certifications/{certificationId}Delete a Certification
CertificationAPIDeletePersonCertificationDelete /persons/{personId}/certifications/{certificationId}Remove an Interest to a Person
CertificationAPIDeleteSkillFromCertificationDelete /certifications/{certificationId}/skills/{skillId}
CertificationAPIGetCertificationGet /certifications/{certificationId}Get details about a Certification
CertificationAPIMoveCertificationPut /certifications/{certificationId}/organizations/{organizationId}Move a Certification to an Organization
CertificationAPISearchCertificationsPost /certifications/searchSearch over certifications
CertificationAPIUpdateCertificationPut /certifications/{certificationId}Update a Certification
CertificationAPIUpdatePersonCertificationPut /persons/{personId}/certifications/{certificationId}Update a Certification of a Person
CertificationAPIUpdateSkillInCertificationPut /certifications/{certificationId}/skills/{skillId}
CountryAPIAddLanguageToCountryPost /countries/{countryId}/languages/{languageId}Assign a language to a country
CountryAPICreateCountryPost /countriesCreate a new Country
CountryAPIDeleteCountryDelete /countries/{countryId}Delete a Country
CountryAPIGetCountryGet /countries/{countryId}Get details about a Country
CountryAPIRemoveLanguageFromCountryDelete /countries/{countryId}/languages/{languageId}Assign a language to a country
CountryAPISearchCountriesPost /countries/searchSearch over countries
CountryAPIUpdateCountryPut /countries/{countryId}Update a Country
CountryAPIUpdateOfficeCountryPut /offices/{officeId}/countries/{countryId}Assign a country to an office
IndustryAPIAttachOrganizationToIndustryPost /organizations/{organizationId}/industries/{industryId}Add an Organization to an Industry
IndustryAPICreateIndustryPost /industriesCreate an Industry
IndustryAPIDeleteIndustryDelete /industries/{industryId}Delete an Industry
IndustryAPIDetachOrganizationFromIndustryDelete /organizations/{organizationId}/industries/{industryId}Remove an Organization to an Industry
IndustryAPIGetIndustryGet /industries/{industryId}Get details about an Industry
IndustryAPISearchIndustriesPost /industries/searchSearch over industries
IndustryAPIUpdateIndustryPut /industries/{industryId}Update an Industry
LanguageAPIAddLanguageToCountryPost /countries/{countryId}/languages/{languageId}Assign a language to a country
LanguageAPIAddPersonLanguagePost /persons/{personId}/languages/{languageId}Assign a language to the person
LanguageAPICreateLanguagePost /languagesCreate a new language
LanguageAPIDeleteLanguageDelete /languages/{languageId}Delete a language
LanguageAPIGetLanguageGet /languages/{languageId}Get details about a language
LanguageAPIRemoveLanguageFromCountryDelete /countries/{countryId}/languages/{languageId}Assign a language to a country
LanguageAPIRemovePersonLanguageDelete /persons/{personId}/languages/{languageId}Remove a language from a person
LanguageAPISearchLanguagesPost /languages/searchSearch over languages
LanguageAPIUpdatePersonLanguagePut /persons/{personId}/languages/{languageId}Update a language of a person
OfficeAPIAddOrganizationOfficePost /organizations/{organizationId}/offices/{officeId}Assign an office to an organization
OfficeAPICreateOfficePost /officesCreate an Office in an Organization
OfficeAPIDeleteOfficeDelete /offices/{officeId}Delete an Office
OfficeAPIDeleteOfficeCountryDelete /offices/{officeId}/countries/{countryId}Delete the office from a Person
OfficeAPIDeleteOrganizationOfficeDelete /organizations/{organizationId}/offices/{officeId}Delete an office from an organization
OfficeAPIDeletePersonOfficeDelete /persons/{personId}/offices/{officeId}Delete the office from a Person
OfficeAPIGetOfficeDetailsGet /offices/{officeId}Get details about an Office
OfficeAPISearchOfficesPost /offices/searchSearch over offices
OfficeAPIUpdateOfficePut /offices/{officeId}Update an Office
OfficeAPIUpdateOfficeCountryPut /offices/{officeId}/countries/{countryId}Assign a country to an office
OfficeAPIUpdatePersonOfficePut /persons/{personId}/offices/{officeId}Assign a person to an office
OrganizationAPIAddExecutiveOrganizationToProjectPost /projects/{projectId}/executive-organizations/{organizationId}Add an Organization to a Project as executive organization
OrganizationAPIAddOrganizationOfficePost /organizations/{organizationId}/offices/{officeId}Assign an office to an organization
OrganizationAPIAddOrganizationToParentOrganizationPost /organizations/{organizationId}/parents/{parentOrganizationId}Attach an Organization to a parent Organization, returns the parent Organization
OrganizationAPIAttachOrganizationToIndustryPost /organizations/{organizationId}/industries/{industryId}Add an Organization to an Industry
OrganizationAPICreateOfficePost /officesCreate an Office in an Organization
OrganizationAPICreateOrganizationPost /organizationsCreate an Organization
OrganizationAPICreateProjectPost /projectsCreate a Project in an Organization
OrganizationAPIDeleteOrganizationDelete /organizations/{organizationId}Delete an organization
OrganizationAPIDeleteOrganizationOfficeDelete /organizations/{organizationId}/offices/{officeId}Delete an office from an organization
OrganizationAPIDetachOrganizationFromIndustryDelete /organizations/{organizationId}/industries/{industryId}Remove an Organization to an Industry
OrganizationAPIGetOrganizationGet /organizations/{organizationId}Get details about an Organization
OrganizationAPIMoveAwardPut /awards/{awardId}/organizations/{organizationId}Move an award to an Organization
OrganizationAPIMoveCertificationPut /certifications/{certificationId}/organizations/{organizationId}Move a Certification to an Organization
OrganizationAPIMoveProjectPut /projects/{projectId}/organizations/{organizationId}Move a Project to an Organization
OrganizationAPIRemoveExecutiveOrganizationFromProjectDelete /projects/{projectId}/executive-organizations/{organizationId}Remove an Organization from a Project as executive organization
OrganizationAPIRemoveOrganizationFromParentOrganizationDelete /organizations/{organizationId}/parents/{parentOrganizationId}Detaches an Organization from parent Organization, return the parent Organization
OrganizationAPIRemoveOrganizationServiceManagerDelete /organizations/{organizationId}/service-manager/{personId}Remove service manager from an Organization
OrganizationAPISearchOrganizationsPost /organizations/searchSearch over organizations
OrganizationAPIUpdateOrganizationPut /organizations/{organizationId}Update an Organization
OrganizationAPIUpdateOrganizationServiceManagerPut /organizations/{organizationId}/service-manager/{personId}Update service manager of an Organization
PDFProfileAPIGeneratePdfProfilePost /pdf-profileGenerate a PDF profile from a Person
PersonAPIAddPersonAwardPost /persons/{personId}/awards/{awardId}Add an award to a Person
PersonAPIAddPersonCertificationPost /persons/{personId}/certifications/{certificationId}Add Certification to a Person
PersonAPIAddPersonInterestPost /persons/{personId}/interests/skills/{skillId}Add an Interest to a Person
PersonAPIAddPersonLanguagePost /persons/{personId}/languages/{languageId}Assign a language to the person
PersonAPIAddPersonProfilePost /persons/{personId}/profiles/{profileId}Add a Profile to a Person
PersonAPIAddPersonSkillExperiencePost /persons/{personId}/experiences/skills/{skillId}Add an Skill experience to a Person
PersonAPIAddPersonSkillExperiencesPost /persons/{personId}/experiencesAdd an Skill experience to a Person (bulk)
PersonAPIAddProjectParticipationPost /project-participationsAdd Project to a Person
PersonAPIAddSkillConfirmationPost /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Confirm Skill
PersonAPICreateAvailabilityPost /persons/{personId}/availabilitiesCreate a availability for a person
PersonAPICreatePersonPost /personsCreate a new Person
PersonAPICreateSkillsProfileForPersonPost /persons/{personId}/skills-profilesCreate a SkillsProfile
PersonAPIDeleteAvailabilityDelete /persons/{personId}/availabilities/{availabilityId}Delete a person availability
PersonAPIDeleteOfficeCountryDelete /offices/{officeId}/countries/{countryId}Delete the office from a Person
PersonAPIDeletePersonDelete /persons/{personId}Delete an existing Person
PersonAPIDeletePersonAwardDelete /persons/{personId}/awards/{awardId}Remove an Award from a Person
PersonAPIDeletePersonCertificationDelete /persons/{personId}/certifications/{certificationId}Remove an Interest to a Person
PersonAPIDeletePersonInterestDelete /persons/{personId}/interests/skills/{skillId}Remove an Interest to a Person
PersonAPIDeletePersonOfficeDelete /persons/{personId}/offices/{officeId}Delete the office from a Person
PersonAPIDeletePersonPictureDelete /persons/{personId}/pictureDelete person image
PersonAPIDeletePersonProfileDelete /persons/{personId}/profiles/{profileId}Remove a Profile from a Person
PersonAPIDeletePersonSkillExperienceDelete /persons/{personId}/experiences/skills/{skillId}Remove an Skill Experience to a Person
PersonAPIDeletePersonSkillExperiencesDelete /persons/{personId}/experiencesRemove an Skill Experience to a Person
PersonAPIDeleteProjectParticipationDelete /project-participations/{projectParticipationId}Remove an Project from a Person
PersonAPIGeneratePdfProfilePost /pdf-profileGenerate a PDF profile from a Person
PersonAPIGetAvailabilitiesGet /persons/{personId}/availabilitiesGet a list of all activities for a person
PersonAPIGetPersonGet /persons/{personId}Get basic info about a person
PersonAPIGetPersonSkillsProfilesGet /persons/{personId}/skills-profilesGet all SkillsProfiles of a single person
PersonAPIReadPersonPictureGet /persons/{personId}/pictureRead person image
PersonAPIReadPersonProjectParticipationGet /persons/{personId}/project-participationGet a Project Participation of a Person
PersonAPIReadPersonSkillStatisticsGet /persons/{personId}/skill-statistic/{skillId}Show detailed statistics of a skill for a person
PersonAPIReadProjectParticipationGet /project-participations/{projectParticipationId}Get a project participation
PersonAPIRemoveManagerDelete /persons/{personId}/managerRemove a manager from a person
PersonAPIRemoveOrganizationServiceManagerDelete /organizations/{organizationId}/service-manager/{personId}Remove service manager from an Organization
PersonAPIRemovePersonLanguageDelete /persons/{personId}/languages/{languageId}Remove a language from a person
PersonAPIRemoveSkillConfirmationDelete /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Remove a confirmation
PersonAPISearchPersonsPost /persons/searchSearch over persons
PersonAPISearchPersonsStatsPost /persons/search/statsProvides search stats (e.g., direct hits) across all persons, ignoring pagination.
PersonAPISearchProjectParticipationsPost /project-participations/searchSearch over project participations
PersonAPISetManagerPut /persons/{personId}/manager/{managerId}Set a manager for a person
PersonAPIUpdateAvailabilityPut /persons/{personId}/availabilities/{availabilityId}Update a person availability
PersonAPIUpdateOrganizationServiceManagerPut /organizations/{organizationId}/service-manager/{personId}Update service manager of an Organization
PersonAPIUpdatePersonPut /persons/{personId}Update an existing Person
PersonAPIUpdatePersonAwardPut /persons/{personId}/awards/{awardId}Update an Award of a Person
PersonAPIUpdatePersonCertificationPut /persons/{personId}/certifications/{certificationId}Update a Certification of a Person
PersonAPIUpdatePersonLanguagePut /persons/{personId}/languages/{languageId}Update a language of a person
PersonAPIUpdatePersonOfficePut /persons/{personId}/offices/{officeId}Assign a person to an office
PersonAPIUpdatePersonPicturePut /persons/{personId}/pictureUpdate person image
PersonAPIUpdatePersonSkillExperiencePut /persons/{personId}/experiences/skills/{skillId}Edit an Skill experience to a Person
PersonAPIUpdatePersonSkillExperiencesPut /persons/{personId}/experiencesEdit an Skill experience to a Person
PersonAPIUpdateProjectParticipationPut /project-participations/{projectParticipationId}Update a Project of a Person
ProfileAPIAddPersonProfilePost /persons/{personId}/profiles/{profileId}Add a Profile to a Person
ProfileAPICreateProfilePost /profilesCreate a new Profile
ProfileAPIDeletePersonProfileDelete /persons/{personId}/profiles/{profileId}Remove a Profile from a Person
ProfileAPIDeleteProfileDelete /profiles/{profileId}Delete a Profile
ProfileAPIGetProfileGet /profiles/{profileId}Get details about a Profile
ProfileAPISearchProfilesPost /profiles/searchSearch over profiles
ProfileAPIUpdateProfilePut /profiles/{profileId}Update a Profile
ProjectAPIAddExecutiveOrganizationToProjectPost /projects/{projectId}/executive-organizations/{organizationId}Add an Organization to a Project as executive organization
ProjectAPIAddProjectParticipationPost /project-participationsAdd Project to a Person
ProjectAPIAddSkillConfirmationPost /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Confirm Skill
ProjectAPICreateProjectPost /projectsCreate a Project in an Organization
ProjectAPIDeleteProjectDelete /projects/{projectId}Delete a project
ProjectAPIDeleteProjectParticipationDelete /project-participations/{projectParticipationId}Remove an Project from a Person
ProjectAPIGetProjectGet /projects/{projectId}Get details about a Project
ProjectAPIMoveProjectPut /projects/{projectId}/organizations/{organizationId}Move a Project to an Organization
ProjectAPIReadProjectParticipationGet /project-participations/{projectParticipationId}Get a project participation
ProjectAPIRemoveExecutiveOrganizationFromProjectDelete /projects/{projectId}/executive-organizations/{organizationId}Remove an Organization from a Project as executive organization
ProjectAPIRemoveSkillConfirmationDelete /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Remove a confirmation
ProjectAPISearchProjectParticipationsPost /project-participations/searchSearch over project participations
ProjectAPISearchProjectsPost /projects/searchComplex search over project entities
ProjectAPISearchProjectsStatsPost /projects/search/statsProvides search stats (e.g., direct hits) across all projects, ignoring pagination.
ProjectAPIUpdateProjectPut /projects/{projectId}Update a Project
ProjectAPIUpdateProjectParticipationPut /project-participations/{projectParticipationId}Update a Project of a Person
ProjectParticipationAPIReadPersonProjectParticipationGet /persons/{personId}/project-participationGet a Project Participation of a Person
SearchAPISearchPost /searchFulltext search on all kinds of objects
SkillAPIAddPersonInterestPost /persons/{personId}/interests/skills/{skillId}Add an Interest to a Person
SkillAPIAddPersonSkillExperiencePost /persons/{personId}/experiences/skills/{skillId}Add an Skill experience to a Person
SkillAPIAddPersonSkillExperiencesPost /persons/{personId}/experiencesAdd an Skill experience to a Person (bulk)
SkillAPIAddSkillConfirmationPost /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Confirm Skill
SkillAPIAddSkillToCertificationPost /certifications/{certificationId}/skills/{skillId}
SkillAPIAddSkillToParentSkillPost /skills/{skillId}/parents/{parentSkillId}Attach a Skill to a parent Skill, returns the parent Skill
SkillAPICreateSkillPost /skillsCreate a Skill
SkillAPIDeletePersonInterestDelete /persons/{personId}/interests/skills/{skillId}Remove an Interest to a Person
SkillAPIDeletePersonSkillExperienceDelete /persons/{personId}/experiences/skills/{skillId}Remove an Skill Experience to a Person
SkillAPIDeletePersonSkillExperiencesDelete /persons/{personId}/experiencesRemove an Skill Experience to a Person
SkillAPIDeleteSkillDelete /skills/{skillId}Delete a Skill
SkillAPIDeleteSkillFromCertificationDelete /certifications/{certificationId}/skills/{skillId}
SkillAPIGetSkillGet /skills/{skillId}Get details for a single skill
SkillAPIReadPersonSkillStatisticsGet /persons/{personId}/skill-statistic/{skillId}Show detailed statistics of a skill for a person
SkillAPIRemoveSkillConfirmationDelete /project-participations/{projectParticipationId}/skills/{skillId}/confirmation/{confirmingPersonId}Remove a confirmation
SkillAPIRemoveSkillFromParentSkillDelete /skills/{skillId}/parents/{parentSkillId}Detaches a Skill from parent Skill, return the parent Skill
SkillAPISearchSkillsPost /skills/searchSearch over skills
SkillAPIUpdatePersonSkillExperiencePut /persons/{personId}/experiences/skills/{skillId}Edit an Skill experience to a Person
SkillAPIUpdatePersonSkillExperiencesPut /persons/{personId}/experiencesEdit an Skill experience to a Person
SkillAPIUpdateSkillPut /skills/{skillId}Update a Skill
SkillAPIUpdateSkillInCertificationPut /certifications/{certificationId}/skills/{skillId}
SkillsProfileAPICreateSkillsProfileForPersonPost /persons/{personId}/skills-profilesCreate a SkillsProfile
SkillsProfileAPIDeleteSkillsProfileDelete /skillsProfiles/{skillsProfileId}Delete a skills profile
SkillsProfileAPIGetPersonSkillsProfilesGet /persons/{personId}/skills-profilesGet all SkillsProfiles of a single person
SkillsProfileAPIGetSkillsProfileGet /skillsProfiles/{skillsProfileId}Get a SkillsProfile
SkillsProfileAPIUpdateSkillsProfilePut /skillsProfiles/{skillsProfileId}Update a SkillsProfile
StatusAPIGetVersionGet /versionInformation about the server
TemplatesAPIGetTemplatesGet /templateslist of existing templates

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

oidcScheme

bearerScheme

  • Type: HTTP Bearer token authentication

Example

auth := context.WithValue(context.Background(), sw.ContextAccessToken, "BEARER_TOKEN_STRING")
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author