Integration of search services into Career APIs

Integration of search services into Career APIs

 

Created Date

Apr 18, 2023

Target PI

PI3

Target Release

Jun 9, 2023

Jira Epic

https://economicmodeling.atlassian.net/browse/CC20-2333

Document Status

Committed

Epic Owner

@Micah Kramer

Stakeholder

Engineering Team(s) Involved

Career coach

PART 1

Customer/User Job-to-be-Done or Problem

When our career apis and search apis were developed they were developed separately, and over time in response to client requests. This led to a disparate creation of services in now outdated modes all the while creating documentation that portrays a unified API interaction. There are many reasons this is odd and now classified as tech debt, but the main reasons are two fold:

  • Quality: The search services are not covered under API tests nor are they monitored for up-time and status resulting in breaking changes that go unnoticed until found by a client.

  • Security: Having the separated search services as we do creates three additional apps each with their own maintenance requirements and security update requirements. Each of them are considerably out of date and carry security vulnerabilities according to the Snyk scans.

 

Value to Customers & Users

  • Quality. This work will bring this functionality under API endpoint tests and will provide regular monitoring and usage internally which will catch errors before users do. Faster error turn around time.

 

Value to Lightcast

Bugs, security issues, maintenance, loss of trust from clients, bad reputation are all less tangible, but very real and very costly things. Value is added when we don’t have to spend on them.

Aka Value of cost reduction.

Target User Role/Client/Client Category

Internal tools, API clients.

 

Delivery Mechanism

Auto delivery. It’ll just show up. No change to user interaction. And hopefully fewer problems are delivered.

 

Success Criteria & Metrics

Search functionality must be included into the Careers APIs, covered by endpoint tests, and used by our frontend applications directly.

 

Aspects that are out of scope (of this phase)

None.

PART 2

Solution Description

Early UX (wireframes or mockups)

<FigmaLink>

 

Non-Functional Attributes & Usage Projections

Consider performance characteristics, privacy/security implications, localization requirements, mobile requirements, accessibility requirements

 

Dependencies

Is there any work that must precede this? Feature work? Ops work? 

 

Legal and Ethical Considerations

No

Have you thought through these considerations (e.g. data privacy) and raised any potential concerns with the Legal team?

High-Level Rollout Strategies

No roll-out strategy necessary. No client changes required.

 

Risks

 

 

Open Questions

 

 


Complete with Engineering Teams

 

Effort Size Estimate

M

Estimated Costs

Direct Financial Costs

Are there direct costs that this feature entails? Dataset acquisition, server purchasing, software licenses, etc.?

 

Team Effort

Each team involved should give a general t-shirt size estimate of their work involved. As the epic proceeds, they can add a link to the Jira epic/issue associated with their portion of this work.

Team

Effort Estimate (T-shirt sizes)

Jira Link

Team

Effort Estimate (T-shirt sizes)

Jira Link

Career Coach

M

https://economicmodeling.atlassian.net/browse/CC20-2333