Files
NodeBB/public/openapi/read/ap.yaml
2024-12-11 11:11:58 -05:00

31 lines
1.0 KiB
YAML

get:
tags:
- activitypub
summary: Fetch URL for in-app processing
description: |
This route accepts a URL in the `resource` query parameter, and runs some quick tests to
determine whether that address points to an ActivityPub resource. If so, then it will try
to process it locally and redirect the user to the local representation of it.
If there is no local representation available, then the user is sent off-site as originally
expected.
parameters:
- in: query
name: resource
schema:
type: string
description: A URL to query for potential ActivityPub resource
example: 'https://example.org/ap'
responses:
"200":
description: Sent if the `/api` prefix is used. The `X-Redirect` header is sent with the redirection target.
headers:
'X-Redirect':
schema:
type: string
"307":
description: Redirect the user to the local representation or original URL.
headers:
Location:
schema:
type: string