Skip to content

API integration #148

@cdcabrera

Description

@cdcabrera

As a developer I need to integrate the API into the PF MCP.

Acceptance criteria

  • API is integrated
  • Offline capabilities are provided via non-blocking crawler

Assumptions and questions

  • implementation for Documentation links should be generated #21 facet review API and directly related to feat: api integration #139
  • Generates a base api.json that is embedded into the MCP with periodic updates
  • On server startup spider/crawler brings api.json up-to-date with the API.
  • API typically updated with releases
  • First round API may have limited read into existing repositories so we maintain docs.json.
    • spidered/crawled/cached api.json + embedded api.json + docs.json are all merged to provide a single source for the MCP that is always up-to-date limited by only the API
  • There is the potential to expand the spider/crawler to other PF maintained repositories but this will be a follow up story/issue

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions