Skip to content

improve UI and backend #366

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 8, 2025

Conversation

ix-56h
Copy link
Contributor

@ix-56h ix-56h commented Jul 3, 2025

Closes: #365
Closes: #24
Closes: #376
Closes: #387

Topics

  • Improve frontend integration, better loading and results behavior and the html is back in jinja templates
    image

  • Swagger UI integrated with gitinjest theme
    image

  • remove repo_url from api error response (already available in the error message and it's empty most of the time)

  • add GET api.gitingest.com/{user}/{repo} endpoint

  • add GET/POST/HEAD/OPTION/DELETE/PUT api.gitingest.com returning the openapi.json content (only the GET is available in the swagger UI since we want LLMs to go there instead of HEAD/DELETE/PUT/OPTION/POST, but they still serves the same file).

  • POST /api/ingest now accept application/json header instead of application/x-www-form (better for LLMs and integrations with our API)
    image
    image

  • POST /api/ingest documentation do not include FastAPI internal request: Request argument anymore since it's not something people (and LLMs) can't and must not send (error prone)
    image

  • Fix tree include/exclude bug(ui): selected/marked files not affected when changing between Exclude and Include pattern #376

  • New download endpoint used to download the full context

@cyclotruc if you think something should be removed from the list i can do it.

@ix-56h ix-56h self-assigned this Jul 3, 2025
@ix-56h ix-56h added work in progress This PR is not ready yet but is being worked on backend backend related frontend frontent related labels Jul 3, 2025
@ix-56h
Copy link
Contributor Author

ix-56h commented Jul 3, 2025

For this PR i'm going to wait until we're good with the whole stuff, meaning that until we have a clue about how we're going to handle the api.gintingest.com subdomain.

@cyclotruc if you got time, please review the current state of the PR, the swagger UI can be improved as you wish.

@filipchristiansen filipchristiansen marked this pull request as draft July 3, 2025 05:21
@ix-56h
Copy link
Contributor Author

ix-56h commented Jul 3, 2025

@cyclotruc regarding comments from #24
i think i should expose a simple optional argument to make the output plain text OR json.

This is way better for LLMs and we keep the possibility to use json for API integrations.

Maybe we can do something like this : default -> plaintext, and "format=json" returns the json format. Still, everything will be easy to understand for LLMs since we have llms.txt with some examples and important note for LLMs, and provide the openapi.json file.

@cyclotruc
Copy link
Member

@ix-56h about exposing an argument format, I agree, but let's keep it for another pr and start with plain text for now

we still need to decide the structure of the json, would it be "summary, tree, content" or keys for each files in the digest? things like that

@cyclotruc
Copy link
Member

@ix-56h I think you can remove the additional tasks from the list for now and instead create an issue toward making the API public and documented

For now, let's just get this PR tested in order to bring back main into a stable state and move forward from there

thanks!

@cyclotruc cyclotruc marked this pull request as ready for review July 4, 2025 00:10
@filipchristiansen filipchristiansen marked this pull request as draft July 4, 2025 09:24
@ix-56h
Copy link
Contributor Author

ix-56h commented Jul 4, 2025

Here's the list of features to add on another PR once main is back to a working state:

  • Serve /api/ingest | /api/{user}/{repo} | /api/ | /api to api.gitingest.com
  • add hint about api doc location in llm.txt
  • Add navbar link for API docs

@ix-56h ix-56h added high priority Fix ASAP and removed work in progress This PR is not ready yet but is being worked on labels Jul 5, 2025
Copy link
Contributor

@filipchristiansen filipchristiansen left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Contributor

@NicolasIRAGNE NicolasIRAGNE left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm besides this (but Im no good at js)

@ix-56h ix-56h force-pushed the 365_improve_ui_and_backend branch 3 times, most recently from fd67762 to 554b611 Compare July 8, 2025 12:05
…i error response, add api endpoints for ingestion and api config json, better docstring for endpoints, fix include/exclude frontend behavior, new download endpoint
@ix-56h ix-56h force-pushed the 365_improve_ui_and_backend branch from 554b611 to 09ba884 Compare July 8, 2025 12:15
@ix-56h ix-56h merged commit 6fbc296 into coderamp-labs:main Jul 8, 2025
19 checks passed
filipchristiansen pushed a commit that referenced this pull request Jul 9, 2025
…i error response, add api endpoints for ingestion and api config json, better docstring for endpoints, fix include/exclude frontend behavior, new download endpoint (#366)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backend backend related frontend frontent related high priority Fix ASAP
Projects
None yet
4 participants