Subscribe to documentation for manifest dependencies

Parse a package manifest and automatically subscribe to documentation for all dependencies.

POST /dependencies/subscribe

Subscribe to documentation for manifest dependencies

cURL

curl --request POST \
  --url https://apigcp.trynia.ai/v2/dependencies/subscribe \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "manifest_content": "<string>",
  "manifest_type": "package.json",
  "filename": "<string>",
  "include_dev_dependencies": false,
  "max_new_indexes": 150
}
'

200

{
  "manifest_type": "<string>",
  "total_dependencies": 123,
  "results": {
    "instant_access": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ],
    "wait_for_indexing": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ],
    "started_indexing": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ],
    "not_found": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ],
    "errors": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ],
    "skipped": [
      {
        "name": "<string>",
        "action": "<string>",
        "docs_url": "<string>",
        "global_source_id": "<string>",
        "namespace": "<string>",
        "message": "<string>"
      }
    ]
  },
  "summary": {
    "instant_access": 123,
    "wait_for_indexing": 123,
    "started_indexing": 123,
    "not_found": 123,
    "errors": 123,
    "skipped": 123
  }
}

Authorizations

Authorization · string · header · required

API key must be provided in the Authorization header

Body

application/json

manifest_content · string · required

Raw content of the manifest file

manifest_type · enum<string> | null

Manifest type. Auto-detected if not provided.

Available options: package.json, requirements.txt, pyproject.toml, Cargo.toml, go.mod, Gemfile

filename · string | null

Original filename for type detection

include_dev_dependencies · boolean · default: false

Include devDependencies/dev-dependencies

max_new_indexes · integer · default: 150

Max number of new indexes to start (0-500)

Required range: 0 <= x <= 500

Response

200

application/json

Successful Response

manifest_type · string · required

total_dependencies · integer · required

results · SubscriptionResults · object · required

Show child attributes

summary · SubscriptionSummary · object · required

Show child attributes