Skip to content

Commit 28c0e0d

Browse files
authored
Various improvements to improve the portal:quickstart experience (#16)
* feat: added meta file, updated theme, favicon and titles in build, enabled golang, refactored TOC and other minor improvements * ref: updated sample guide * feat: replaced calculator with petstore spec * ref: replaced square brackets in UserAgent header
1 parent 4274667 commit 28c0e0d

File tree

9 files changed

+1331
-122
lines changed

9 files changed

+1331
-122
lines changed

APIMATIC-BUILD.json

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@
55
"debug": {
66
"publishReport": true
77
},
8-
"pageTitle": "My Portal Title",
9-
"navTitle": "My Navigation Title",
8+
"pageTitle": "My First Portal",
9+
"navTitle": "Developer Experience Portal",
1010
"logoUrl": "static/images/logo.png",
1111
"logoLink": "https://www.apimatic.io",
12+
"faviconUrl": "static/images/favicon.ico",
1213
"languageConfig": {
1314
"http": {},
1415
"java": {
@@ -23,18 +24,21 @@
2324
"typescript": {},
2425
"php": {},
2526
"python": {},
26-
"ruby": {}
27+
"ruby": {},
28+
"go":{}
29+
2730
},
2831
"headIncludes": " <link href=\"https:\\/\\/fonts.googleapis.com\\/css?family=Open+Sans:300,300i,400,400i,600,600i,700,700i,800,800i&display=swap\" rel=\"stylesheet\">",
2932
"portalSettings": {
30-
"themeOverrides": {
31-
"themeType": "cool",
32-
"palette": {
33-
"primaryColor": "#94C13D"
33+
"theme": {
34+
"baseTheme": "standard",
35+
"colorMode": {
36+
"defaultMode": "system",
37+
"disableSwitch": false
3438
}
3539
},
3640
"enableExport": true,
3741
"enableConsoleCalls": true
3842
}
3943
}
40-
}
44+
}

content/guides/guide1.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Calculator API
1+
# This is a Custom Guide
22

3-
This section can contain Tutorials/Guides/Changelogs or any information that API providers want to expose to their users besides what is auto-generated by Apimatic.
3+
This page can contain Tutorials/Guides/Changelogs or any information that API providers want to expose to their users besides what is auto-generated by Apimatic.
44

content/guides/toc.yml

Lines changed: 0 additions & 5 deletions
This file was deleted.

content/toc.yml

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,18 @@ toc:
22
- group: Getting Started
33
items:
44
# 'generate' specifies that this item will be auto-generated by APIMatic. A file/directory reference is not needed here
5-
- generate: How to Get Started
5+
- generate: Quickstart
66
from: getting-started
7-
- group: Guides
8-
dir: guides
7+
- group: Developer Guides
8+
items:
9+
- page: Sample Guide
10+
file: guides/guide1.md
911
# The Endpoint and Models sections contain auto-generated content. The 'generate' and 'from' directives instruct APIMatic's Docs generation service
1012
# to generate and insert these sections here.
1113
- generate: API Endpoints
1214
from: endpoints
1315
- generate: Models
1416
from: models
17+
- generate: SDK Infrastructure
18+
from: sdk-infra
19+

spec/APIMATIC-META.json

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
{
2+
"ImportSettings": {
3+
"AutoGenerateTestCases": false,
4+
"ImportAdditionalHeader": false,
5+
"ImportAdditionalTypeCombinatorModels": false,
6+
"ImportTypeCombinatorsWithOnlyOneType": false
7+
},
8+
"CodeGenSettings": {
9+
"Timeout": 30,
10+
"ValidateRequiredParameters": true,
11+
"AddSingleAuthDeprecatedCode": false,
12+
"EnableGlobalUserAgent": true,
13+
"UserAgent": "{language}-SDK/{version} (OS: {os-info}, Engine: {engine}/{engine-version})",
14+
"EnableLogging": true,
15+
"EnableModelKeywordArgsInRuby": true,
16+
"SymbolizeHashKeysInRuby": true,
17+
"ReturnCompleteHttpResponse": true,
18+
"UserConfigurableRetries": true,
19+
"UseEnumPrefix": false,
20+
"ExtendedAdditionalPropertiesSupport": true,
21+
"EnforceStandardizedCasing": true,
22+
"ControllerPostfix": "Api",
23+
"DoNotSplitWords": ["oauth"]
24+
}
25+
}

spec/Apimatic-Calculator.json

Lines changed: 0 additions & 104 deletions
This file was deleted.

0 commit comments

Comments
 (0)