Skip to content

chore(docs): add openAPI schema#120

Merged
ruocco-l merged 2 commits into
masterfrom
chore/add-openapi-schema
Jul 22, 2026
Merged

chore(docs): add openAPI schema#120
ruocco-l merged 2 commits into
masterfrom
chore/add-openapi-schema

Conversation

@ruocco-l

@ruocco-l ruocco-l commented Jul 21, 2026

Copy link
Copy Markdown
Collaborator

Closes #92

Adding openAPI for both RAG and URL2M

@nicklamonov

Copy link
Copy Markdown
Collaborator

As commented in Slack:

URL2M:

  • the description of the endpoint says "An Apify Actor that takes....". Should we rather keep such actor description at the actor level and change the description for the endpoint a bit? Functionally it's fine.

RAG

  • I also don't like a part of description. Maybe we should remove this - "Web browser for OpenAI Assistants API and RAG pipelines, similar to a web browser in ChatGPT."?
  • At the same I would mention that if only the URL is provided, we do a fetch of that URL only. Now it's not explicit and humans/agents might not understand the difference.

@nicklamonov nicklamonov left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thanks! All good from my side.

@ruocco-l
ruocco-l merged commit 53e380e into master Jul 22, 2026
2 checks passed
@ruocco-l
ruocco-l deleted the chore/add-openapi-schema branch July 22, 2026 10:24

@nikitachapovskii-dev nikitachapovskii-dev left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Thank you, @ruocco-l !

I noticed rag readme is updated for openapi but url2m not, maybe we should update it as well?

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Did you skip some fields because they are hidden? (removeElementsCssSelector, desiredConcurrency, debugMode)
Should we in that case skip requestTimeoutSecs and debugMode for rag?

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah we can do that

"description": "Apify Proxy configuration used for scraping the target web pages.",
"required": false,
"schema": {
"type": "object",

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I asked Claude to compare this PR with the web-fetch one (apify/actor-web-fetch#1) and it flagged a difference that proxyConfiguration here has type: object while there they got headers type: string (JSON-encoded) for the GET
I guess we should align it here to be string as well so it JSON.parse's correclty

                    {
                        "name": "headers",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string",
                            "description": "Additional HTTP headers to send with the request, as a JSON-encoded object string."
                        },
                        "example": "{\"Accept-Language\":\"de-DE\"}"
                    },

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Yeah, this is correct, I'll change it

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

RAG: Update standby server OpenAPI schema

4 participants