Skip to content

Commit abb1efe

Browse files
etiennerobagliaetiennerobaglia
authored
v11.1.0: Remove Web API v2 (#109)
* v10.2.0: webapi 3.8.0 * v10.2.0: fix v3 changelog * v11.0.0: multi version / msdk v2.2 / webportal ref * jekyll github action deployment * master branch workflow * test fork gh hosting * enable GH action workflow * update gemfile * update gemfile (add kramdown) * update gemfile * exclude vendor from config * remove test baseurl * webapi: remove web api v2 * v11.1.0: remove webapi v2
1 parent 1282d50 commit abb1efe

35 files changed

Lines changed: 118 additions & 1089 deletions

‎README.md‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ This website is documentation portal including references, tutorials and good pr
88

99
## API
1010

11-
- ☁️ Web API B2B v2 [ [Documentation](https://developer.groupe-psa.io/webapi/b2b/overview/about/) | [References](https://developer.groupe-psa.io/webapi/b2b/api-reference-v2/specification/) ]
12-
- ☁️ Web API B2B v3 [ [Documentation](https://developer.groupe-psa.io/webapi/b2b/overview/about/) | [References](https://developer.groupe-psa.io/webapi/b2b/api-reference-v3/specification/) ]
11+
- ☁️ Web API B2B v3 [ [Documentation](https://developer.groupe-psa.io/webapi/b2b/overview/about/) | [References](https://developer.groupe-psa.io/webapi/b2b/api-reference/specification/) ]
1312
- ☁️ Web API B2C v4 [ [Documentation](https://developer.groupe-psa.io/webapi/b2c/overview/about/) | [References](https://developer.groupe-psa.io/webapi/b2c/api-reference/specification/#article) ] *(not publicly available yet)*
1413
- 🚙 Embedded Webportal v1 [ [Documentation](https://developer.groupe-psa.io/webportal/v1/overview/about/) | [References](https://developer.groupe-psa.io/webportal/v1/api-reference/list/) ]
1514
- 🚙 Embedded Webportal v2 [ [Documentation](https://developer.groupe-psa.io/webportal/v2/overview/about/) | [References](https://developer.groupe-psa.io/webportal/v2/api-reference/list/) ]
@@ -25,13 +24,13 @@ An overview of **data and features** within connected vehicle API is available b
2524

2625
In case you find anything wrong, a typo or if you don't understand something, you can submit a pull request or open an issue in this repo.
2726

28-
If you need to get in touch with PSA to access B2B API, you can use this [contact form](https://developer.groupe-psa.io/contact-us/).
27+
If you need to get in touch with PSA to access B2B APIs, you can use this [contact form](https://developer.groupe-psa.io/contact-us/).
2928

3029
## 📝 Changelog
3130

3231
This website is often updated, if you want to keep track of these changes you can access the [website changelog](https://developer.groupe-psa.io/changelog/).
3332

34-
Changelog also exists for Web API [B2B v2](https://developer.groupe-psa.io/webapi/b2b/api-reference-v2/changelog/) & [B2B v3](https://developer.groupe-psa.io/webapi/b2b/api-reference-v3/changelog/).
33+
Changelog also exists for [WebAPI B2B v3](https://developer.groupe-psa.io/webapi/b2b/api-reference/changelog/) & [Mobile SDK](https://developer.groupe-psa.io/mobile-sdk/references/changelog/#article).
3534

3635
## 🙏 Credits
3736

‎_config.yml‎

Lines changed: 40 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6,20 +6,21 @@ baseurl: "" # the subpath of the site, e.g. /blog
66
url: "https://developer.groupe-psa.io" # the base hostname & protocol for the site, e.g. http://example.com
77

88
# github links
9-
gitHubURL: "https://github.com/GroupePSA/groupepsa.github.io/tree/master/"
10-
gitHubSpecB2B: "https://github.com/GroupePSA/groupepsa.github.io/blob/master/assets/openapi/api-b2b-webhook-template.yaml"
11-
gitHubSpecB2C: "https://github.com/GroupePSA/groupepsa.github.io/blob/master/assets/openapi/psacc.yaml"
9+
gitHubURL: "https://github.psa-cloud.com/p4d00/doc/tree/master/"
10+
gitHubSpecB2B: "https://github.psa-cloud.com/mph00/Spec/blob/master/spec/api/b2b/api-b2b.yaml"
11+
gitHubSpecB2C: "https://github.psa-cloud.com/mph00/Spec/blob/master/spec/api/b2c/psacc.yaml"
12+
gitHubSpecMobileSdk: "https://github.psa-cloud.com/mmx00/PIMSSpecification"
13+
gitHubSpecWebSdk: "https://github.psa-cloud.com/p4d00/web-sdk-spec"
14+
gitHubMasterPath: "/blob/master/"
1215

1316
# doc versionning
14-
doc-version: "11.0.0"
17+
doc-version: "11.1.0"
1518

1619
# WEB API BaseURI - theses var have to be renamed without prod/preprod (because we display only one at once)
1720
webapiB2C: "https://api.groupe-psa.com/connectedcar/v4"
1821
cvsOAuth2: "https://idpcvs.{brand.tld}/am/oauth2/access_token"
1922
virtualKeyToken: "https://api.groupe-psa.com/connectedcar/v3"
20-
webapiB2B: "https://api-cert.groupe-psa.com/connectedcar/{version}"
21-
webapiB2Bv3: "https://api-cert.groupe-psa.com/connectedcar/v3"
22-
webapiB2Bv2: "https://api-cert.groupe-psa.com/connectedcar/v2"
23+
webapiB2B: "https://api-cert.groupe-psa.com/connectedcar/v3"
2324

2425
collections:
2526
webportal-nac-reference:
@@ -47,13 +48,42 @@ exclude:
4748
- "README.md"
4849
- "Rakefile"
4950
- "vendor"
51+
- "vendor"
5052

5153
plugins:
5254
- jekyll-redirect-from
5355
- jekyll-datapage-generator
56+
- jekyll-datapage-generator
5457

5558
page_gen-dirs: true
59+
page_gen-dirs: true
5660

61+
page_gen:
62+
# ----------------------------------------------
63+
# ----------------------------------------------
64+
# ------------------MOBILE SDK------------------
65+
# ----------------------------------------------
66+
# ----------------------------------------------
67+
- data: mobile-sdk-changelog
68+
template: api-reference-list-v2-mobile_sdk
69+
dir: /mobile-sdk/references/
70+
name_expr: + "v" + record['version'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
71+
title_expr: + "References v" + record['version']
72+
- data: mobile-sdk-v2-0.apis
73+
template: api-reference-mobile-sdk
74+
dir: /mobile-sdk/references/v2-0/
75+
name_expr: record['component']['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['type'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
76+
title: apiName
77+
- data: mobile-sdk-v2-1.apis
78+
template: api-reference-mobile-sdk
79+
dir: /mobile-sdk/references/v2-1/
80+
name_expr: record['component']['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['type'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
81+
title: apiName
82+
- data: mobile-sdk-v2-2.apis
83+
template: api-reference-mobile-sdk
84+
dir: /mobile-sdk/references/v2-2/
85+
name_expr: record['component']['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['type'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
86+
title: apiName
5787
page_gen:
5888
# ----------------------------------------------
5989
# ----------------------------------------------
@@ -84,6 +114,9 @@ page_gen:
84114
# name_expr: record['component'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['type'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
85115
# .downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
86116
# downcase makes it lowercase. The strip makes sure there is no leading or trailing whitespace. The first gsub replaces spaces with hyphens. The second gsub removes all non-alpha non-dash non-underscore characters (note that this set is very close to \W but includes the dash as well, which is why it's spelled out here).
117+
# name_expr: record['component'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['type'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-') + "-" + record['tag'].downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '-')
118+
# .downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
119+
# downcase makes it lowercase. The strip makes sure there is no leading or trailing whitespace. The first gsub replaces spaces with hyphens. The second gsub removes all non-alpha non-dash non-underscore characters (note that this set is very close to \W but includes the dash as well, which is why it's spelled out here).
87120

88121

89122
kramdown:

‎_data/sections.yml‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -42,10 +42,6 @@
4242
path: standards/
4343
- name: Errors & Rate Limit
4444
path: errors/
45-
- name: Try it Out!
46-
path: demo/
47-
- name: About Versions
48-
path: about-versions/
4945
- name: Data Scope
5046
path: data-scope/
5147
- name: Quickstart
@@ -64,10 +60,8 @@
6460
path: set-up/
6561
- name: Retry Policy
6662
path: retry-policy/
67-
- name: Webhook References v2
68-
path: webhook-v2/
69-
- name: Webhook References v3
70-
path: webhook-v3/
63+
- name: Webhook References
64+
path: webhook/
7165
- name: Remote
7266
path: remote/
7367
pages:
@@ -81,19 +75,12 @@
8175
path: notifications-errors/
8276
- name: Webhook References
8377
path: webhook/
84-
- name: API Reference v2
85-
path: api-reference-v2/
86-
pages:
87-
- name: Specification Version 2
88-
path: specification/
89-
- name: Changelog Version 2
90-
path: changelog/
91-
- name: API Reference v3
92-
path: api-reference-v3/
78+
- name: API Reference
79+
path: api-reference/
9380
pages:
94-
- name: Specification Version 3
81+
- name: Specification Version 3
9582
path: specification/
96-
- name: Changelog Version 3
83+
- name: Changelog Version 3
9784
path: changelog/
9885
- tag: b2c
9986
path: b2c/

‎_includes/content-header.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -192,11 +192,11 @@ <h1 id="page-title">
192192
</div>
193193
{% elsif page.section == "webapi" and page.subsection == "b2c" %}
194194
<div class="notification page-disclaimer">
195-
<strong>Info:</strong> Stellantis End User API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is <strong>not publicly available</strong> yet.
195+
<strong>Info:</strong> Stellantis End User API for ex Groupe PSA brands (Citroën, DS, Peugeot, Opel and Vauxhall) is <strong>not publicly available</strong>.
196196
</div>
197197
{% elsif page.section == "mobile-sdk" %}
198198
<div class="notification page-disclaimer">
199-
<strong>Info:</strong> Stellantis Mobile SDK is <strong>not publicly available</strong> yet.
199+
<strong>Info:</strong> Stellantis Mobile SDK is <strong>not publicly available</strong>.
200200
</div>
201201
{% endif %}
202202
{%- comment -%}---END DISCLAIMER---{%- endcomment -%}

‎_includes/data-catalog-script.html‎

Lines changed: 6 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,6 @@
9494
</div>
9595

9696
<div class="table-header-api-available">
97-
<div class="table-header-version">
98-
<input type="checkbox" class="api-version-checkbox" checked="true" id="webapi_b2b_v2" name="api" value="webapi_b2b_v2">
99-
<label>Web API B2B v2</label>
100-
</div>
10197
<div class="table-header-version">
10298
<input type="checkbox" class="api-version-checkbox" checked="true" id="webapi_b2b_v3" name="api" value="webapi_b2b_v3">
10399
<label>Web API B2B v3</label>
@@ -152,7 +148,6 @@
152148
{field:"update", type:"like", value:searchInput},
153149
{field:"webportal_v1", type:"like", value:searchInput},
154150
{field:"webportal_v2", type:"like", value:searchInput},
155-
{field:"webapi_b2b_v2", type:"like", value:searchInput},
156151
{field:"webapi_b2b_v3", type:"like", value:searchInput},
157152
{field:"webapi_b2c_v4", type:"like", value:searchInput}
158153
]
@@ -177,10 +172,11 @@
177172
webportal: {
178173
v1: "/webportal/v1/api-reference/",
179174
v2: "/webportal/v2/api-reference/",
175+
v1: "/webportal/v1/api-reference/",
176+
v2: "/webportal/v2/api-reference/",
180177
},
181178
webapi: {
182-
v2: "/webapi/b2b/api-reference-v2/specification/",
183-
v3: "/webapi/b2b/api-reference-v3/specification/",
179+
v3: "/webapi/b2b/api-reference/specification/",
184180
v4: "/webapi/b2c/api-reference/specification/",
185181
}
186182
}
@@ -250,8 +246,8 @@
250246
};
251247

252248

253-
function taggifyWebapi(v2, v3, v4){
254-
if(!v2 && !v3 && !v4){
249+
function taggifyWebapi(v3, v4){
250+
if(!v3 && !v4){
255251
return (
256252
"<div class='control'>"+
257253
"<div class='tags has-addons n-a'>"+
@@ -266,12 +262,8 @@
266262
"</div>"
267263
)}
268264
else{
269-
var tagAddonV2 = "";
270265
var tagAddonV3 = "";
271266
var tagAddonV4 = "";
272-
if (v2) {
273-
tagAddonV2 = taggify("webapi", v2, "v2");
274-
}
275267
if (v3) {
276268
tagAddonV3 = taggify("webapi", v3, "v3");
277269
}
@@ -287,7 +279,6 @@
287279
"</span>"
288280
+"<span class='availability-name'>Web API</span>"+
289281
"</span>"+
290-
tagAddonV2+
291282
tagAddonV3+
292283
tagAddonV4+
293284
"</div>"+
@@ -358,10 +349,9 @@
358349
cellContents,
359350
itemCategorieLogo = domain_categories[data.domain],
360351
elementWebportal = taggifyWebportal(data.webportal_v1, data.webportal_v2),
361-
elementWebapi = taggifyWebapi(data.webapi_b2b_v2, data.webapi_b2b_v3, data.webapi_b2c_v4),
352+
elementWebapi = taggifyWebapi(data.webapi_b2b_v3, data.webapi_b2c_v4),
362353
elementType = taggify(false, false, data.type),
363354
elementUnitValue = codify(data.unit_or_value),
364-
elementWebapi_v2,
365355
elementWebapi_v3,
366356
elementWebapi_v4,
367357
elementWeportal_v1,
@@ -427,14 +417,12 @@
427417
const checkboxesNotFiltered = {
428418
"webportal_v1": "-",
429419
"webportal_v2": "-",
430-
"webapi_b2b_v2": "#",
431420
"webapi_b2b_v3": "#",
432421
"webapi_b2c_v4": "#"
433422
}
434423
var checkboxesState = {
435424
"webportal_v1": "-",
436425
"webportal_v2": "-",
437-
"webapi_b2b_v2": "#",
438426
"webapi_b2b_v3": "#",
439427
"webapi_b2c_v4": "#"
440428
},
@@ -455,7 +443,6 @@
455443
[
456444
{field:"webportal_v1", type:"like", value:checkboxesState["webportal_v1"]},
457445
{field:"webportal_v2", type:"like", value:checkboxesState["webportal_v2"]},
458-
{field:"webapi_b2b_v2", type:"like", value:checkboxesState["webapi_b2b_v2"]},
459446
{field:"webapi_b2b_v3", type:"like", value:checkboxesState["webapi_b2b_v3"]},
460447
{field:"webapi_b2c_v4", type:"like", value:checkboxesState["webapi_b2c_v4"]}
461448
]

‎_includes/webapi-curl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ $ curl \
8282
class="{{header_class}}"
8383
href="{{site.baseurl}}
8484
{%- if page.subsection == "b2c" -%}/webapi/b2c/api-reference/specification/#operation/{{include.referenceURLResssourceB2C}}
85-
{%- elsif page.subsection == "b2b" -%}/webapi/b2b/api-reference-v3/specification/#operation/{{include.referenceURLResssourceB2B}}{%- endif -%}"
85+
{%- elsif page.subsection == "b2b" -%}/webapi/b2b/api-reference/specification/#operation/{{include.referenceURLResssourceB2B}}{%- endif -%}"
8686
>
8787
{{include.httpVerb}} |&nbsp;
8888

‎_layouts/default.html‎

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,6 @@
5050
<link href="https://unpkg.com/tabulator-tables@4.6.3/dist/css/bulma/tabulator_bulma.min.css" rel="stylesheet">
5151
<script type="text/javascript" src="https://unpkg.com/tabulator-tables@4.6.3/dist/js/tabulator.min.js"></script>
5252
{% endif %}
53-
{%- comment -%} WEBAPI-DEMO {%- endcomment -%}
54-
{% if page.require contains "webapi-demo" %}
55-
<link rel="stylesheet" href="{{ 'webapi-demo.css' | prepend: modules_path| prepend: site.baseurl }}">
56-
{% endif %}
5753
{%- comment -%} WEBAPI-REFERENCE-SPECIFICATION {%- endcomment -%}
5854
{% if page.require contains "webapi-reference-specification" %}
5955
<link rel="stylesheet" href="{{ 'webapi-reference-specification.css' | prepend: modules_path| prepend: site.baseurl }}">

0 commit comments

Comments
 (0)