Specification contains various ApiBuilder attributes, which are recognized by Postman Collection Generator
| https://app.apibuilder.io/apicollective/apibuilder-spec/latest/service.json |
| Name | Value | Description |
|---|---|---|
| postman-basic-auth | postman-basic-auth | |
| object-reference | object-reference | |
| organization-setup | organization-setup |
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| username | string | Yes | - | Specifies the username to be used in Postman Collection auth definition. It may be also a variable reference.
|
| password | string | Yes | - | Specified the password to be used in Postman Collection auth definition. It may be also a variable reference. Leave this string empty, when only a username is needed.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| related_service_namespace | string | Yes | - | ApiBuilder service's namespace, in which a target operation is specified.
|
| resource_type | string | Yes | - | Resource type, that holds a referenced operation.
|
| operation_method | io.apibuilder.spec.v0.enums.method:0.15.90 | Yes | - | Referenced operation method.
|
| identifier_field | string | Yes | - | A field name. When the referenced operation is called, identifier_field is used to extract the corresponding field from the response JSON.
|
Interfaces: None
| Field | Type | Required? | Default | Description |
|---|---|---|---|---|
| related_service_namespace | string | Yes | - | ApiBuilder service's namespace, in which a target operation is specified.
|
| resource_type | string | Yes | - | Resource type, that holds a referenced operation.
|
| operation_method | io.apibuilder.spec.v0.enums.method:0.15.90 | Yes | - | Referenced operation method.
|
| identifier_field | string | Yes | - | A field name. When the referenced operation is called, identifier_field is used to extract the corresponding field from the response JSON.
|
| path | string | No | - | Path from resource
|
