Skip to content

Commit 7671775

Browse files
committed
Improve formatting and consistency in configuration and documentation files
1 parent 81046a3 commit 7671775

8 files changed

Lines changed: 52 additions & 46 deletions

File tree

code0-tech-hercules-1.0.0.tgz

183 Bytes
Binary file not shown.

code0-tech-tucana-0.0.0.tgz

32.4 KB
Binary file not shown.

docs/Actions/GLS/configs.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,14 @@ The GLS action requires a few credentials to authenticate with the GLS ShipIT AP
1111

1212
## Configuration reference
1313

14-
| Config Name | Type | Required | Default | Description |
15-
|-----------------|-------------|----------|---------|-------------|
16-
| `client_id` | string | **Yes** || OAuth2 client ID for authenticating with the GLS API |
17-
| `client_secret` | string | **Yes** || OAuth2 client secret for authenticating with the GLS API |
18-
| `contact_id` | string | No | `""` | GLS contact ID used in some API requests (see note below) |
19-
| `ship_it_api_url` | string | No | `https://api.gls-group.net/shipit-farm/v1/backend/rs` | GLS ShipIT API base URL |
20-
| `auth_url` | string | No | `https://api.gls-group.net/oauth2/v2/token` | GLS OAuth2 token endpoint — must end in `/token` |
21-
| `shipper` | GLS_SHIPPER | No || Default shipper address used when no shipper is provided in the shipment data |
14+
| Config Name | Type | Required | Default | Description |
15+
|-------------------|-------------|----------|-------------------------------------------------------|-------------------------------------------------------------------------------|
16+
| `client_id` | string | **Yes** | | OAuth2 client ID for authenticating with the GLS API |
17+
| `client_secret` | string | **Yes** | | OAuth2 client secret for authenticating with the GLS API |
18+
| `contact_id` | string | No | `""` | GLS contact ID used in some API requests (see note below) |
19+
| `ship_it_api_url` | string | No | `https://api.gls-group.net/shipit-farm/v1/backend/rs` | GLS ShipIT API base URL |
20+
| `auth_url` | string | No | `https://api.gls-group.net/oauth2/v2/token` | GLS OAuth2 token endpoint — must end in `/token` |
21+
| `shipper` | GLS_SHIPPER | No | | Default shipper address used when no shipper is provided in the shipment data |
2222

2323
> **`contact_id`:** This identifier is required for certain shipment operations (e.g. end-of-day reports and some services). It is issued by GLS support — contact them directly to request it.
2424

docs/Actions/GLS/functions.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -179,12 +179,12 @@ All shipment functions accept a common set of parameters in addition to their ty
179179

180180
**Common parameters for all shipment functions:**
181181

182-
| Parameter | Type | Required | Description |
183-
|-----------|------|----------|-------------|
184-
| `shipment` | GLS_SHIPMENT_WITHOUT_SERVICES | **Yes** | Shipment data (consignee, shipper, units, product) |
185-
| `printingOptions` | GLS_PRINTING_OPTIONS | **Yes** | Label format settings |
186-
| `returnOptions` | GLS_RETURN_OPTIONS | No | Whether to return print data and routing info |
187-
| `customContent` | GLS_CUSTOM_CONTENT | No | Custom logo and barcode settings |
182+
| Parameter | Type | Required | Description |
183+
|-------------------|-------------------------------|----------|----------------------------------------------------|
184+
| `shipment` | GLS_SHIPMENT_WITHOUT_SERVICES | **Yes** | Shipment data (consignee, shipper, units, product) |
185+
| `printingOptions` | GLS_PRINTING_OPTIONS | **Yes** | Label format settings |
186+
| `returnOptions` | GLS_RETURN_OPTIONS | No | Whether to return print data and routing info |
187+
| `customContent` | GLS_CUSTOM_CONTENT | No | Custom logo and barcode settings |
188188

189189
---
190190

docs/Actions/GLS/overview.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,20 +27,20 @@ Before using the GLS Action you will need:
2727

2828
### Hercules / Aquila
2929

30-
| Requirement | Description |
31-
|-------------|-------------|
32-
| Running Aquila server | The action connects to Aquila on startup to register its functions |
33-
| `HERCULES_AUTH_TOKEN` | Auth token issued by your Aquila instance |
34-
| `HERCULES_AQUILA_URL` | Host and port of your Aquila server (e.g. `aquila.example.com:50051`) |
35-
| Docker + Docker Compose | Used to run the action as a container |
30+
| Requirement | Description |
31+
|-------------------------|-----------------------------------------------------------------------|
32+
| Running Aquila server | The action connects to Aquila on startup to register its functions |
33+
| `HERCULES_AUTH_TOKEN` | Auth token issued by your Aquila instance |
34+
| `HERCULES_AQUILA_URL` | Host and port of your Aquila server (e.g. `aquila.example.com:50051`) |
35+
| Docker + Docker Compose | Used to run the action as a container |
3636

3737
### GLS Developer Portal
3838

39-
| Requirement | How to obtain |
40-
|-------------|---------------|
41-
| `client_id` | Create an application at [https://dev-portal.gls-group.net](https://dev-portal.gls-group.net) and find it under **My Apps** |
42-
| `client_secret` | Found alongside the `client_id` in **My Apps** on the GLS developer portal |
43-
| `contact_id` *(optional)* | Issued by GLS support — contact them directly to request it |
39+
| Requirement | How to obtain |
40+
|---------------------------|-----------------------------------------------------------------------------------------------------------------------------|
41+
| `client_id` | Create an application at [https://dev-portal.gls-group.net](https://dev-portal.gls-group.net) and find it under **My Apps** |
42+
| `client_secret` | Found alongside the `client_id` in **My Apps** on the GLS developer portal |
43+
| `contact_id` *(optional)* | Issued by GLS support — contact them directly to request it |
4444

4545
> **Note:** The `contact_id` is required for some shipment operations. If you are unsure whether you need it, contact GLS support.
4646

docs/Actions/GLS/quick-start.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,12 +13,12 @@ This guide walks you through creating your first GLS shipment using the GLS Acti
1313

1414
Follow the [Installation Guide](../../Guides/installation.md) to deploy the GLS Action, then set the following configuration values in your Hercules admin panel (or `.env` file):
1515

16-
| Config | Value |
17-
|--------|-------|
18-
| `client_id` | Your GLS OAuth2 client ID |
19-
| `client_secret` | Your GLS OAuth2 client secret |
16+
| Config | Value |
17+
|-------------------|--------------------------------------------------------------------------------------|
18+
| `client_id` | Your GLS OAuth2 client ID |
19+
| `client_secret` | Your GLS OAuth2 client secret |
2020
| `ship_it_api_url` | GLS ShipIT endpoint (default: `https://api.gls-group.net/shipit-farm/v1/backend/rs`) |
21-
| `auth_url` | GLS auth endpoint (default: `https://api.gls-group.net/oauth2/v2/token`) |
21+
| `auth_url` | GLS auth endpoint (default: `https://api.gls-group.net/oauth2/v2/token`) |
2222

2323
See [Configuration](./configs.md) for the full list of options and how to obtain credentials.
2424

docs/Actions/GLS/troubleshooting.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -111,10 +111,10 @@ A: Yes, use the `reprintParcel` function with the `TrackID` and the original `Cr
111111

112112
## Common error codes
113113

114-
| Error Code | Cause | Resolution |
115-
|------------|-------|------------|
116-
| `ERROR_CREATING_GLS_SHIPMENT` | API returned an error during shipment creation or management | Check `validateShipment` output for details |
117-
| `INVALID_PRODUCT` | Used `"PARCEL"` product with a service that requires `"EXPRESS"` | Set `Product: "EXPRESS"` in the shipment |
114+
| Error Code | Cause | Resolution |
115+
|-------------------------------|------------------------------------------------------------------|---------------------------------------------|
116+
| `ERROR_CREATING_GLS_SHIPMENT` | API returned an error during shipment creation or management | Check `validateShipment` output for details |
117+
| `INVALID_PRODUCT` | Used `"PARCEL"` product with a service that requires `"EXPRESS"` | Set `Product: "EXPRESS"` in the shipment |
118118

119119
---
120120

@@ -178,11 +178,11 @@ Open a pull request against the `main` branch of [code0-tech/centaurus](https://
178178

179179
### Development commands
180180

181-
| Command | Description |
182-
|---------|-------------|
183-
| `npm run build` | Build all actions |
184-
| `npm run test` | Run the test suite |
185-
| `npm run test:watch` | Run tests in watch mode |
186-
| `npm run lint` | Run ESLint |
187-
| `npm run create-action -- <name>` | Scaffold a new action |
181+
| Command | Description |
182+
|-----------------------------------|-------------------------|
183+
| `npm run build` | Build all actions |
184+
| `npm run test` | Run the test suite |
185+
| `npm run test:watch` | Run tests in watch mode |
186+
| `npm run lint` | Run ESLint |
187+
| `npm run create-action -- <name>` | Scaffold a new action |
188188

package-lock.json

Lines changed: 11 additions & 5 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)