Skip to content

OpenAPI #5

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
orzocogorzo merged 18 commits into from
Nov 18, 2025
Merged

OpenAPI #5

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
8291bb6
feat: dolibarr swagger json
orzocogorzo Sep 19, 2025
a4063a1
feat: add openapi spec reader
orzocogorzo Sep 19, 2025
3f48042
fix: place of the openapi explorer class
orzocogorzo Nov 17, 2025
af9fad8
feat: add http method arg on endpoint schema callback
orzocogorzo Nov 18, 2025
1f61d79
feat: fetch dolibarr swagger on endpoint introspections
orzocogorzo Nov 18, 2025
04d13fd
feat: swagger mailchimp introspection
orzocogorzo Nov 18, 2025
ac4cc94
feat: oas brevo introspection
orzocogorzo Nov 18, 2025
fb6b023
feat: expand body params as object types with properties on oas explorer
orzocogorzo Nov 18, 2025
b592543
feat: holded oas introspection
orzocogorzo Nov 18, 2025
b771243
feat: listmonk oas yaml introspection
orzocogorzo Nov 18, 2025
c4f5102
feat: odoo addon list models method
orzocogorzo Nov 18, 2025
6f9e3da
fix: holded endpoint schema method arguments
orzocogorzo Nov 18, 2025
12a01e5
fix: openapi following of requestBody parameters refs
orzocogorzo Nov 18, 2025
e7d6336
feat: brevo list endpoints method
orzocogorzo Nov 18, 2025
1e5b0b7
feat: spoof headers on openapi data requests to external sources
orzocogorzo Nov 18, 2025
a73fe8e
feat: improve brevo swagger request spoofing
orzocogorzo Nov 18, 2025
7ffa1c0
feat: addon endpoint schema method API standarization
orzocogorzo Nov 18, 2025
8fb3d49
feat: include method on endpoint schema requests
orzocogorzo Nov 18, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 8 additions & 3 deletions forms-bridge/addons/bigin/class-bigin-addon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -101,12 +101,17 @@ public function ping( $backend ) {
/**
* Performs an introspection of the backend endpoint and returns API fields.
*
* @param string $endpoint API endpoint.
* @param string $backend Backend name.
* @param string $endpoint API endpoint.
* @param string $backend Backend name.
* @param string|null $method HTTP method.
*
* @return array List of fields and content type of the endpoint.
*/
public function get_endpoint_schema( $endpoint, $backend ) {
public function get_endpoint_schema( $endpoint, $backend, $method = null ) {
if ( in_array( $method, array( 'POST', 'PUT' ), true ) ) {
return array();
}

if (
! preg_match(
'/\/(([A-Z][a-z]+(_[A-Z][a-z])?)(?:\/upsert)?$)/',
Expand Down
307 changes: 86 additions & 221 deletions forms-bridge/addons/brevo/class-brevo-addon.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,21 +25,28 @@ class Brevo_Addon extends Addon {
*
* @var string
*/
const TITLE = 'Brevo';
public const TITLE = 'Brevo';

/**
* Handles the addon's name.
*
* @var string
*/
const NAME = 'brevo';
public const NAME = 'brevo';

/**
* Handles the addom's custom bridge class.
*
* @var string
*/
const BRIDGE = '\FORMS_BRIDGE\Brevo_Form_Bridge';
public const BRIDGE = '\FORMS_BRIDGE\Brevo_Form_Bridge';

/**
* Holds the OAS URL.
*
* @var string
*/
public const OAS_URL = 'https://developers.brevo.com/reference/get_companies?json=on';

/**
* Performs a request against the backend to check the connexion status.
Expand Down Expand Up @@ -91,241 +98,99 @@ public function fetch( $endpoint, $backend ) {
}

/**
* Performs an introspection of the backend endpoint and returns API fields
* and accepted content type.
* Fetch available models from the OAS spec.
*
* @param string $endpoint API endpoint.
* @param string $backend Backend name.
* @param Backend $backend HTTP backend object.
*
* @return array
*
* @todo Implementar el endpoint de consulta de endpoints disponibles.
*/
public function get_endpoint_schema( $endpoint, $backend ) {
$bridge = new Brevo_Form_Bridge(
public function get_endpoints( $backend ) {
$response = wp_remote_get(
self::OAS_URL,
array(
'name' => '__brevo-' . time(),
'endpoint' => $endpoint,
'backend' => $backend,
'method' => 'GET',
'headers' => array(
'Accept' => 'application/json',
'Host' => 'developers.brevo.com',
'Referer' => 'https://developers.brevo.com/reference/get_companies',
'Alt-Used' => 'developers.brevo.com',
'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0',
),
)
);

if ( strstr( $bridge->endpoint, 'contacts' ) ) {
$response = $bridge
->patch(
array(
'name' => 'brevo-contacts-attributes',
'endpoint' => '/v3/contacts/attributes',
'method' => 'GET',
)
)
->submit();

if ( is_wp_error( $response ) ) {
return array();
}
if ( is_wp_error( $response ) ) {
return array();
}

if ( $bridge->endpoint === '/v3/contacts/doubleOptinConfirmation' ) {
$fields = array(
array(
'name' => 'email',
'schema' => array( 'type' => 'string' ),
'required' => true,
),
array(
'name' => 'includeListIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
'required' => true,
),
array(
'name' => 'excludeListIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'templateId',
'schema' => array( 'type' => 'integer' ),
'required' => true,
),
array(
'name' => 'redirectionUrl',
'schema' => array( 'type' => 'string' ),
'required' => true,
),
array(
'name' => 'attributes',
'schema' => array(
'type' => 'object',
'properties' => array(),
),
),
);
} else {
$fields = array(
array(
'name' => 'email',
'schema' => array( 'type' => 'string' ),
'required' => true,
),
array(
'name' => 'ext_id',
'schema' => array( 'type' => 'string' ),
),
array(
'name' => 'emailBlacklisted',
'schema' => array( 'type' => 'boolean' ),
),
array(
'name' => 'smsBlacklisted',
'schema' => array( 'type' => 'boolean' ),
),
array(
'name' => 'listIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'updateEnabled',
'schema' => array( 'type' => 'boolean' ),
),
array(
'name' => 'smtpBlacklistSender',
'schema' => array( 'type' => 'boolean' ),
),
array(
'name' => 'attributes',
'schema' => array(
'type' => 'object',
'properties' => array(),
),
),
);
}
$data = json_decode( $response['body'], true );
$oa_explorer = new OpenAPI( $data['oasDefinition'] );

foreach ( $response['data']['attributes'] as $attribute ) {
$fields[] = array(
'name' => 'attributes.' . $attribute['name'],
'schema' => array( 'type' => 'string' ),
);
}
$paths = $oa_explorer->paths();

return $fields;
} else {
if ( ! preg_match( '/\/([a-z]+)$/', $bridge->endpoint, $matches ) ) {
return array();
}
return array_map(
function ( $path ) {
return '/v3' . $path;
},
$paths,
);
}

$module = $matches[1];
$response = $bridge
->patch(
array(
'name' => "brevo-{$module}-attributes",
'endpoint' => "/v3/crm/attributes/{$module}",
'method' => 'GET',
)
)
->submit();
/**
* Performs an introspection of the backend endpoint and returns API fields
* and accepted content type.
*
* @param string $endpoint API endpoint.
* @param string $backend Backend name.
* @param string|null $method HTTP method.
*
* @return array
*/
public function get_endpoint_schema( $endpoint, $backend, $method = null ) {
$bytes = random_bytes( 16 );
$bytes[6] = chr( ord( $bytes[6] ) & 0x0f | 0x40 ); // set version to 0100
$bytes[8] = chr( ord( $bytes[8] ) & 0x3f | 0x80 ); // set bits 6-7 to 10
$uuid = vsprintf( '%s%s-%s-%s-%s-%s%s%s', str_split( bin2hex( $bytes ), 4 ) );

$response = wp_remote_get(
self::OAS_URL,
array(
'headers' => array(
'Accept' => 'application/json',
'Host' => 'developers.brevo.com',
'Referer' => 'https://developers.brevo.com/reference/get_companies',
'Alt-Used' => 'developers.brevo.com',
'User-Agent' => 'Mozilla/5.0 (X11; Linux x86_64; rv:144.0) Gecko/20100101 Firefox/144.0',
'X-Requested-With' => 'XMLHttpRequest',
),
'cookies' => array(
'anonymous_id' => $uuid,
'first_referrer' => 'https://app.brevo.com/',
'pscd' => 'get.brevo.com',
'readme_language' => 'shell',
'readme_library' => '{%22shell%22:%22curl%22}',
),
)
);

if ( is_wp_error( $response ) ) {
return array();
}
if ( is_wp_error( $response ) ) {
return array();
}

if ( 'companies' === $module ) {
$fields = array(
array(
'name' => 'name',
'schema' => array( 'type' => 'string' ),
'required' => true,
),
array(
'name' => 'countryCode',
'schema' => array( 'type' => 'integer' ),
),
array(
'name' => 'linkedContactsIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'linkedDealsIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'attributes',
'schema' => array(
'type' => 'object',
'properties' => array(),
),
),
);
} elseif ( 'deals' === $module ) {
$fields = array(
array(
'name' => 'name',
'schema' => array( 'type' => 'string' ),
'required' => true,
),
array(
'name' => 'linkedDealsIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'linkedCompaniesIds',
'schema' => array(
'type' => 'array',
'items' => array( 'type' => 'integer' ),
),
),
array(
'name' => 'attributes',
'schema' => array(
'type' => 'object',
'properties' => array(),
),
),
);
}
$data = json_decode( $response['body'], true );
if ( ! $data ) {
return array();
}

foreach ( $response['data'] as $attribute ) {
switch ( $attribute['attributeTypeName'] ) {
case 'number':
$type = 'number';
break;
case 'text':
$type = 'string';
break;
case 'user':
$type = 'email';
break;
case 'date':
$type = 'date';
break;
default:
$type = 'string';
}
$oa_explorer = new OpenAPI( $data['oasDefinition'] );

$fields[] = array(
'name' => 'attributes.' . $attribute['internalName'],
'schema' => array( 'type' => $type ),
);
}
$method = strtolower( $method ?? 'post' );
$path = preg_replace( '/^\/v\d+/', '', $endpoint );
$source = in_array( $method, array( 'post', 'put', 'patch' ), true ) ? 'body' : 'query';
$params = $oa_explorer->params( $path, $method, $source );

return $fields;
}
return $params ?: array();
}
}

Expand Down
Loading