njsi.herokuapp.com.yaml

{"openapi":"3.0.1","info":{"title":"NJSI Plugin","description":"A plugin to allow Singaporeans who are switching careers, to search for adjacent occupations that will provide a higher salary than their current occupation, where occupation adjacency is measured through common skills required by the occupations, with occupations defined by the Singapore Standard Occupation Classification (SSOC) 2020 version. The full Terms and Conditions can be found at the linked URL.","termsOfService":"https://njsi.herokuapp.com/legal","version":"v1"},"servers":[{"url":"https://njsi.herokuapp.com"}],"paths":{"/api/v1/disclaimer":{"get":{"operationId":"disclaimer","summary":"Default path to call before any other API is called. This provides a disclaimer for users on the beta version of the API which may lead to inaccuracies and therefore users should use it at their own risk. Improvements are being made along the way with more complete data.","responses":{"200":{"description":"OK"}}}},"/api/v1/destinations":{"post":{"operationId":"destinations","summary":"Search the SSG job and skills knowledge graph for occupations adjacent to the one in current_SSOC, providing difference in starting and typical salary, common required skills and delta in differentiator skills between the two occupations","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/destinationsRequest"}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/whoami":{"post":{"operationId":"whoami","summary":"Search the SSG job and skills knowledge graph for the occupation attributes such as necessary and differentiator skills, their ranking, and salary range associated with the occupation in current_SSOC","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/whoamiRequest"}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/target":{"post":{"operationId":"target","summary":"Probe the SSG job and skills graph for insights between two occupations (current_SSOC and target_SSOC), providing required and unique skills, their rankings, and starting and typical salary comparison","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/targetRequest"}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/ssocSearch":{"post":{"operationId":"ssocSearch","summary":"Search for all the matched ssoc code at 5-digit level, based on the input_job_title term, which is a job title, input by user.","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssocSearchRequest"}}}},"responses":{"200":{"description":"OK"}}}},"/api/v1/courseSearch":{"post":{"operationId":"courseSearch","summary":"Search for all the matched courses in SSG based on user query. Returns the course id with area of training, course desciption, course objective, course title, course skill list and course url that brings users to the course page in ssg website","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ssocSearchRequest"}}}},"responses":{"200":{"description":"OK"}}}}},"components":{"schemas":{"destinationsRequest":{"type":"object","properties":{"input_dict":{"type":"object","properties":{"current_SSOC":{"type":"string"}}}},"required":["current_SSOC"]},"whoamiRequest":{"type":"object","properties":{"input_dict":{"type":"object","properties":{"current_SSOC":{"type":"string"}}}},"required":["current_SSOC"]},"targetRequest":{"type":"object","properties":{"input_dict":{"type":"object","properties":{"current_SSOC":{"type":"string"},"target_SSOC":{"type":"string"}}}},"required":["current_SSOC","target_SSOC"]},"ssocSearchRequest":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]},"courseSearchRequest":{"type":"object","properties":{"query":{"type":"string"}},"required":["query"]}}}}