python-sdk/examples/snippets/manifest-source.json at main · OilpriceAPI/python-sdk · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
{
  "schema_version": "1.0.0",
  "package": {
    "name": "oilpriceapi",
    "language": "python",
    "minimum_runtime": "3.8"
  },
  "examples": [
    {
      "id": "python.latest-price",
      "path": "examples/snippets/latest_price.py",
      "kind": "success",
      "endpoint": "GET /v1/prices/latest",
      "docs_url": "https://docs.oilpriceapi.com/quick-start/python",
      "expected_response_shape": {
        "commodity": "string",
        "currency": "string",
        "unit": "string",
        "source": "string",
        "api_timestamp": "string",
        "timestamp_field": "string",
        "value_type": "string",
        "freshness": "string|null"
      }
    },
    {
      "id": "python.history",
      "path": "examples/snippets/history.py",
      "kind": "success",
      "endpoint": "GET /v1/prices/past_year",
      "docs_url": "https://docs.oilpriceapi.com/quick-start/python",
      "expected_response_shape": {
        "commodity": "string",
        "count": "integer",
        "value_type": "string"
      }
    },
    {
      "id": "python.authentication-error",
      "path": "examples/snippets/authentication_error.py",
      "kind": "recovery",
      "endpoint": "GET /v1/prices/latest",
      "http_status": 401,
      "docs_url": "https://docs.oilpriceapi.com/guides/authentication",
      "expected_response_shape": {"handled": "boolean", "status_code": "integer"}
    },
    {
      "id": "python.entitlement-error",
      "path": "examples/snippets/entitlement_error.py",
      "kind": "recovery",
      "endpoint": "GET /v1/prices/latest",
      "http_status": 403,
      "docs_url": "https://docs.oilpriceapi.com/guides/error-codes",
      "expected_response_shape": {"handled": "boolean", "status_code": "integer"}
    },
    {
      "id": "python.rate-limit-error",
      "path": "examples/snippets/rate_limit_error.py",
      "kind": "recovery",
      "endpoint": "GET /v1/prices/latest",
      "http_status": 429,
      "docs_url": "https://docs.oilpriceapi.com/guides/error-codes",
      "expected_response_shape": {"handled": "boolean", "status_code": "integer"}
    },
    {
      "id": "python.timeout-error",
      "path": "examples/snippets/timeout_error.py",
      "kind": "recovery",
      "endpoint": "GET /v1/prices/latest",
      "docs_url": "https://docs.oilpriceapi.com/guides/error-codes",
      "expected_response_shape": {"handled": "boolean", "error_type": "string"}
    }
  ]
}