```
--------------------------------
### Common Headers Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/configuration.md
A JSON array providing examples of common HTTP request headers.
```json
[
{ "name": "Content-Type", "value": "application/json" },
{ "name": "Accept", "value": "application/json" },
{ "name": "Authorization", "value": "Bearer {{token}}" },
{ "name": "User-Agent", "value": "MyApp/1.0" }
]
```
--------------------------------
### Example Secret Variable Configuration
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/configuration.md
An example of a secret variable configuration.
```json
{
"name": "apiKey",
"secret": true,
"type": "string"
}
```
--------------------------------
### Input Schema Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/api-reference/converters.md
Provides an example of the expected structure for the `brunoCollection` parameter in the `brunoToOpenCollection` function.
```javascript
{
name: string,
root?: {
docs?: string,
request?: {
url?: string,
method?: string,
headers?: Array<{ name, value, enabled? }>,
params?: Array<{ name, value, type? }>,
body?: BodyObject,
auth?: AuthObject,
vars?: { req?: Array
},
script?: { req?: string, res?: string },
assertions?: Array
}
},
environments?: Array<{
filename: string,
variables?: Array
}>,
items?: Array-
}
Where Item can be:
- HTTP Request: `{ type: 'http-request', name, request: {...} }`
- GraphQL Request: `{ type: 'graphql-request', name, ... }`
- Folder: `{ type: 'folder', name, items: Array
- , ... }`
```
--------------------------------
### HttpRequestExample
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/types.md
Example request/response pair for documentation.
```typescript
interface HttpRequestExample {
name?: string;
description?: Description;
request?: HttpRequestExampleRequest;
response?: HttpRequestExampleResponse;
}
interface HttpRequestExampleRequest {
url?: string;
method?: string;
headers?: HttpRequestHeader[];
params?: HttpRequestParam[];
body?: HttpRequestBody;
}
interface HttpRequestExampleResponse {
status?: number;
statusText?: string;
headers?: HttpResponseHeader[];
body?: HttpRequestExampleResponseBody;
}
interface HttpRequestExampleResponseBody {
type: 'json' | 'text' | 'xml' | 'html' | 'binary';
data: string;
}
```
--------------------------------
### OpenCollection Initialization
Source: https://github.com/opencollection-dev/opencollection/blob/main/examples/standalone-html/index2.html
Initializes OpenCollection within a specified HTML container using a sample collection configuration.
```javascript
const container = document.getElementById('opencollection-container');
new window.OpenCollection({
target: container,
opencollection: sampleCollection,
theme: 'light'
});
```
--------------------------------
### Example Collection Metadata
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/configuration.md
JSON object representing example collection metadata, including name, summary, version, and author details.
```json
{
"name": "My API",
"summary": "Documentation for My API",
"version": "2.1.0",
"authors": [
{
"name": "John Doe",
"email": "john@example.com",
"url": "https://johndoe.com"
}
]
}
```
--------------------------------
### Schema Extension Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/api-reference/schema.md
Example of extending the OpenCollection schema with a custom property.
```javascript
const customSchema = {
...OpenCollectionSchema,
properties: {
...OpenCollectionSchema.properties,
"x-custom": { type: "object" }
}
};
```
--------------------------------
### Authentication Inheritance Configuration
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/configuration.md
Example of how to inherit authentication settings from a parent scope.
```typescript
// Inherit authentication from parent scope
auth: 'inherit'
```
--------------------------------
### Authentication Conversion Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/api-reference/converters.md
Demonstrates the conversion of Bruno's 'basic' authentication mode to OpenCollection's equivalent.
```javascript
// Bruno basic auth
{
mode: "basic",
basic: {
username: "user@example.com",
password: "mypassword"
}
}
// OpenCollection
{
type: "basic",
username: "user@example.com",
password: "mypassword"
}
```
--------------------------------
### Error Handling Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/api-reference/converters.md
Shows how to use a try-catch block to handle potential errors during the `brunoToOpenCollection` conversion process.
```javascript
try {
const result = brunoToOpenCollection(null);
} catch (error) {
console.error(error.message); // "Bruno collection is required"
}
```
--------------------------------
### Sample OpenCollection Configuration
Source: https://github.com/opencollection-dev/opencollection/blob/main/examples/standalone-html/index.html
This YAML defines a sample API collection with various HTTP requests, folders, environments, and variables.
```yaml
name: Sample API Collection
description: A comprehensive OpenCollection demonstration showcasing various API endpoints and configurations
items:
- type: http
name: Get Users
method: GET
url: https://jsonplaceholder.typicode.com/users
docs: Retrieves a list of all users from the JSONPlaceholder API
headers:
- name: Accept
value: application/json
- name: User-Agent
value: OpenCollection-Playground/1.0
params:
- name: limit
value: "10"
type: query
enabled: true
- type: http
name: Create User
method: POST
url: https://jsonplaceholder.typicode.com/users
docs: Creates a new user in the system
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |
{
"name": "John Doe",
"email": "john@example.com",
"phone": "1-770-736-8031 x56442",
"website": "hildegard.org"
}
auth:
type: bearer
token: your-api-token-here
- type: http
name: Update User
method: PUT
url: https://jsonplaceholder.typicode.com/users/1
docs: Updates an existing user by ID
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |
{
"name": "Jane Doe",
"email": "jane@example.com"
}
- type: http
name: Delete User
method: DELETE
url: https://jsonplaceholder.typicode.com/users/1
docs: Deletes a user by ID
- type: folder
name: Posts
items:
- type: http
name: Get All Posts
method: GET
url: https://jsonplaceholder.typicode.com/posts
docs: Retrieves all blog posts
- type: http
name: Get Post by ID
method: GET
url: https://jsonplaceholder.typicode.com/posts/1
docs: Retrieves a specific post by its ID
params:
- name: id
value: "1"
type: path
enabled: true
- type: http
name: Create Post
method: POST
url: https://jsonplaceholder.typicode.com/posts
docs: Creates a new blog post
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |
{
"title": "My New Post",
"body": "This is the content of my new post",
"userId": 1
}
- type: folder
name: People
items:
- type: http
name: Get All Posts
method: GET
url: https://jsonplaceholder.typicode.com/posts
docs: Retrieves all blog posts
- type: http
name: Get Post by ID
method: GET
url: https://jsonplaceholder.typicode.com/posts/1
docs: Retrieves a specific post by its ID
params:
- name: id
value: "1"
type: path
enabled: true
- type: http
name: Create Post
method: POST
url: https://jsonplaceholder.typicode.com/posts
docs: Creates a new blog post
headers:
- name: Content-Type
value: application/json
body:
type: json
data: |
{
"title": "My New Post",
"body": "This is the content of my new post",
"userId": 1
}
environments:
- name: Production
description: Production environment configuration
variables:
- name: baseUrl
value: https://api.example.com
- name: apiKey
value: prod-api-key-here
- name: Development
description: Development environment for testing
variables:
- name: baseUrl
value: http://localhost:3000
- name: apiKey
value: dev-api-key-here
- name: Staging
description: Staging environment for QA testing
variables:
- name: baseUrl
value: https://staging-api.example.com
- name: apiKey
value: staging-api-key-here
base:
headers:
- name: Accept
value: application/json
- name: User-Agent
value: OpenCollection/1.0
variables:
- name: timeout
value: "30000"
docs: This is a sample OpenCollection that demonstrates various features including HTTP requests, folders, scripts, environments, and authentication methods. It uses the JSONPlaceholder API for testing purposes.
```
--------------------------------
### Example Usage of OpenCollection
Source: https://github.com/opencollection-dev/opencollection/blob/main/_autodocs/api-reference/opencollection-types.md
Demonstrates how to create an OpenCollection object with basic information and items.
```typescript
import type { OpenCollection } from '@opencollection/types';
const collection: OpenCollection = {
info: {
name: "My API",
version: "1.0.0"
},
opencollection: "0.9.2",
items: [
{
info: { name: "Get User", type: "http" },
http: {
method: "GET",
url: "https://api.example.com/users/:id"
}
}
]
};
```
--------------------------------
### OpenCollection Standalone HTML Example
Source: https://github.com/opencollection-dev/opencollection/blob/main/examples/standalone-html/index2.html
This code snippet shows a basic HTML structure with embedded OpenCollection data.
```html
OpenCollection Standalone Example