scribe.php 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?php
  2. return [
  3. "labels" => [
  4. "search" => "Search",
  5. "base_url" => "Base URL",
  6. ],
  7. "auth" => [
  8. "none" => "This API is not authenticated.",
  9. "instruction" => [
  10. "query" => <<<TEXT
  11. To authenticate requests, include a query parameter **`:parameterName`** in the request.
  12. TEXT,
  13. "body" => <<<TEXT
  14. To authenticate requests, include a parameter **`:parameterName`** in the body of the request.
  15. TEXT,
  16. "query_or_body" => <<<TEXT
  17. To authenticate requests, include a parameter **`:parameterName`** either in the query string or in the request body.
  18. TEXT,
  19. "bearer" => <<<TEXT
  20. To authenticate requests, include an **`Authorization`** header with the value **`"Bearer :placeholder"`**.
  21. TEXT,
  22. "basic" => <<<TEXT
  23. To authenticate requests, include an **`Authorization`** header in the form **`"Basic {credentials}"`**.
  24. The value of `{credentials}` should be your username/id and your password, joined with a colon (:),
  25. and then base64-encoded.
  26. TEXT,
  27. "header" => <<<TEXT
  28. To authenticate requests, include a **`:parameterName`** header with the value **`":placeholder"`**.
  29. TEXT,
  30. ],
  31. "details" => <<<TEXT
  32. All authenticated endpoints are marked with a `requires authentication` badge in the documentation below.
  33. TEXT,
  34. ],
  35. "headings" => [
  36. "introduction" => "Introduction",
  37. "auth" => "Authenticating requests",
  38. ],
  39. "endpoint" => [
  40. "request" => "Request",
  41. "headers" => "Headers",
  42. "url_parameters" => "URL Parameters",
  43. "body_parameters" => "Body Parameters",
  44. "query_parameters" => "Query Parameters",
  45. "response" => "Response",
  46. "response_fields" => "Response Fields",
  47. "example_request" => "Example request",
  48. "example_response" => "Example response",
  49. "responses" => [
  50. "binary" => "Binary data",
  51. "empty" => "Empty response",
  52. ],
  53. ],
  54. "try_it_out" => [
  55. "open" => "Try it out ⚡",
  56. "cancel" => "Cancel 🛑",
  57. "send" => "Send Request 💥",
  58. "loading" => "⏱ Sending...",
  59. "received_response" => "Received response",
  60. "request_failed" => "Request failed with error",
  61. "error_help" => <<<TEXT
  62. Tip: Check that you're properly connected to the network.
  63. If you're a maintainer of ths API, verify that your API is running and you've enabled CORS.
  64. You can check the Dev Tools console for debugging information.
  65. TEXT,
  66. ],
  67. "links" => [
  68. "postman" => "View Postman collection",
  69. "openapi" => "View OpenAPI spec",
  70. ],
  71. ];