Skip to content
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

docs(bpdm): update openApi spec for rc5 #1119

Merged
merged 1 commit into from
Nov 22, 2024
Merged

docs(bpdm): update openApi spec for rc5 #1119

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/api/gate.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Business Partner Data Management Gate",
"description": "A gate for a member to share business partner data with CatenaX",
"version": "6.2.0-SNAPSHOT"
"version": "6.2.0-rc5"
},
"servers": [
{
Expand Down
2 changes: 1 addition & 1 deletion docs/api/gate.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.1
info:
title: Business Partner Data Management Gate
description: A gate for a member to share business partner data with CatenaX
version: 6.2.0-SNAPSHOT
version: 6.2.0-rc5
servers:
- url: http://localhost:8081
description: Generated server url
Expand Down
37 changes: 33 additions & 4 deletions docs/api/orchestrator.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,22 @@
"info": {
"title": "Business Partner Data Management Orchestrator",
"description": "Orchestrator component acts as a passive component and offers for each processing steps individual endpoints",
"version": "6.2.0-SNAPSHOT"
"version": "6.2.0-rc5"
},
"servers": [
{
"url": "http://localhost:8085",
"description": "Generated server url"
}
],
"security": [
{
"open_id_scheme": []
},
{
"bearer_scheme": []
}
],
"paths": {
"/v6/golden-record-tasks": {
"post": {
Expand Down Expand Up @@ -494,15 +502,15 @@
"properties": {
"longitude": {
"type": "number",
"format": "float"
"format": "double"
},
"latitude": {
"type": "number",
"format": "float"
"format": "double"
},
"altitude": {
"type": "number",
"format": "float"
"format": "double"
}
},
"description": "The exact location of the physical postal address in latitude, longitude, and altitude."
Expand Down Expand Up @@ -1194,6 +1202,27 @@
},
"description": "Business partner data that has not yet or can not be categorized"
}
},
"securitySchemes": {
"open_id_scheme": {
"type": "oauth2",
"flows": {
"clientCredentials": {
"tokenUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token"
},
"authorizationCode": {
"authorizationUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth",
"tokenUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token",
"refreshUrl": "http://localhost:8180/realms/CX-Central/protocol/openid-connect/token",
"scopes": {}
}
}
},
"bearer_scheme": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
}
}
}
}
26 changes: 22 additions & 4 deletions docs/api/orchestrator.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,13 @@ openapi: 3.0.1
info:
title: Business Partner Data Management Orchestrator
description: Orchestrator component acts as a passive component and offers for each processing steps individual endpoints
version: 6.2.0-SNAPSHOT
version: 6.2.0-rc5
servers:
- url: http://localhost:8085
description: Generated server url
security:
- open_id_scheme: []
- bearer_scheme: []
paths:
/v6/golden-record-tasks:
post:
Expand Down Expand Up @@ -347,13 +350,13 @@ components:
properties:
longitude:
type: number
format: float
format: double
latitude:
type: number
format: float
format: double
altitude:
type: number
format: float
format: double
description: The exact location of the physical postal address in latitude, longitude, and altitude.
Identifier:
type: object
Expand Down Expand Up @@ -861,3 +864,18 @@ components:
address:
$ref: '#/components/schemas/PostalAddress'
description: Business partner data that has not yet or can not be categorized
securitySchemes:
open_id_scheme:
type: oauth2
flows:
clientCredentials:
tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
authorizationCode:
authorizationUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/auth
tokenUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
refreshUrl: http://localhost:8180/realms/CX-Central/protocol/openid-connect/token
scopes: {}
bearer_scheme:
type: http
scheme: bearer
bearerFormat: JWT
26 changes: 13 additions & 13 deletions docs/api/pool.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"info": {
"title": "Business Partner Data Management Pool",
"description": "Service that manages and shares business partner data with other CatenaX services",
"version": "6.2.0-SNAPSHOT"
"version": "6.2.0-rc5"
},
"servers": [
{
Expand Down Expand Up @@ -2281,11 +2281,11 @@
"$ref": "#/components/schemas/ErrorInfoAddressCreateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down Expand Up @@ -2340,11 +2340,11 @@
"$ref": "#/components/schemas/ErrorInfoAddressUpdateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down Expand Up @@ -4174,11 +4174,11 @@
"$ref": "#/components/schemas/ErrorInfoLegalEntityCreateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down Expand Up @@ -4243,11 +4243,11 @@
"$ref": "#/components/schemas/ErrorInfoLegalEntityUpdateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down Expand Up @@ -6545,11 +6545,11 @@
"$ref": "#/components/schemas/ErrorInfoSiteCreateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down Expand Up @@ -6610,11 +6610,11 @@
"$ref": "#/components/schemas/ErrorInfoSiteUpdateError"
}
},
"errorCount": {
"entityCount": {
"type": "integer",
"format": "int32"
},
"entityCount": {
"errorCount": {
"type": "integer",
"format": "int32"
}
Expand Down
26 changes: 13 additions & 13 deletions docs/api/pool.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ openapi: 3.0.1
info:
title: Business Partner Data Management Pool
description: Service that manages and shares business partner data with other CatenaX services
version: 6.2.0-SNAPSHOT
version: 6.2.0-rc5
servers:
- url: http://localhost:8080
description: Generated server url
Expand Down Expand Up @@ -1682,10 +1682,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoAddressCreateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down Expand Up @@ -1724,10 +1724,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoAddressUpdateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down Expand Up @@ -3364,10 +3364,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoLegalEntityCreateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down Expand Up @@ -3413,10 +3413,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoLegalEntityUpdateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down Expand Up @@ -5499,10 +5499,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoSiteCreateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down Expand Up @@ -5545,10 +5545,10 @@ components:
type: array
items:
$ref: '#/components/schemas/ErrorInfoSiteUpdateError'
errorCount:
entityCount:
type: integer
format: int32
entityCount:
errorCount:
type: integer
format: int32
description: Holds information about successfully and failed entities after the creating/updating of several objects
Expand Down
Loading