Skip to content

Adding Tenant routes #7

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
elliot-huffman merged 7 commits into from
Mar 25, 2025
Merged

Adding Tenant routes #7

Changes from 4 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
cc1bcc2
Adding new endpoints to handle Customer operations
pasha-zayko Mar 13, 2025
6926842
Adding another response
pasha-zayko Mar 13, 2025
0488b18
Updating endpoints per business requirements
pasha-zayko Mar 14, 2025
db430d3
Small comment updates
pasha-zayko Mar 17, 2025
2692854
Merge branch 'main' into pasha-customer-api-dg
pasha-zayko Mar 17, 2025
4e094af
Update to endpoints
pasha-zayko Mar 21, 2025
18bb932
Wording
elliot-huffman Mar 25, 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
250 changes: 250 additions & 0 deletions Data-Gateway.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,20 @@
"example": "1.12.5",
"type": "string"
}
},
"customerId": {
"description": "The object ID of the customer value to operate against.",
"in": "path",
"name": "customerId",
"required": true,
"schema": {
"example": "3b241101-e2bb-4255-8caf-4136c566a962",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
}
}
},
"responses": {
Expand Down Expand Up @@ -804,6 +818,65 @@
],
"title": "Update SHIELD Tenant - configuration entry",
"type": "object"
},
"CustomerList.Record": {
"title": "Customer List Record",
"description": "Details of a single entry in the list of customer records",
"properties": {
"customerId": {
"description": "The object ID of the customer record",
"example": "1c4d2f3b-2e4b-4a5b-8c6d-7e8f9a0b1c2d",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"customerDisplayName": {
"description": "Human readable name for the customer record",
"example": "Contoso - Prod",
"type": "string"
}
},
"type": "object",
"required": [
"customerId",
"customerDisplayName"
]
},
"Customer.Record": {
"title": "Customer Record",
"description": "Details of a single customer record requested directly that includes additional information",
"properties": {
"customerId": {
"description": "The object ID of the customer record",
"example": "1c4d2f3b-2e4b-4a5b-8c6d-7e8f9a0b1c2d",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"customerDisplayName": {
"description": "Human readable name for the customer record",
"example": "Contoso - Prod",
"type": "string"
},
"tenantList": {
"description": "Object representing collection of tenant records that include tenant id and name and are associated with this customer record",
"additionalProperties": {
"description": "Human readable name for the tenant record",
"type": "string"
},
"type": "object"
}
},
"type": "object",
"required": [
"customerId",
"customerDisplayName",
"tenantIdList"
]
}
},
"securitySchemes": {
Expand Down Expand Up @@ -2648,6 +2721,183 @@
"SHIELD - Update"
]
}
},
"/API/Customer/" : {
"get": {
"description": "Retrieves the list of unique customer records in the system. This endpoint requires the `Customer.Read.All` or `Customer.ReadWrite.All` scopes (permissions).",
"operationId": "/API/Customer/Get",
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"minItems": 0,
"items": {
"$ref": "#/components/schemas/CustomerList.Record"
}
},
"examples": {
"Example List Of Customer Records": {
"description": "Sample list of unique customer records in the system",
"summary": "Existing Customer Records",
"value": [
{
"customerId": "5d6e7f8a-9b0c-1d2e-3f4a-5b6c7d8e9f0a",
"customerDisplayName": "Contoso - Legal"
},
{
"customerId": "7e8f9a0b-1c2d-3e4b-5a6c-7d8e9f0a1b2c",
"customerDisplayName": "Contoso - R&D"
}
]
}
}
}
},
"description": "OK"
}
},
"summary": "Retrieves list of customer records",
"tags": [
"Customer Records"
]
}
},
"/API/Customer/{customerId}/": {
"get": {
"description": "Retrieves complete details of one customer record including associated list of tenant records. This endpoint requires the `Customer.Read.All` or `Customer.ReadWrite.All` scopes (permissions).",
"operationId": "/API/Customer/:customerId/Get",
"parameters": [
{
"$ref": "#/components/parameters/customerId"
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Customer.Record"
},
"examples": {
"Example Complete Customer Record": {
"description": "Sample details of one customer record with list of associated tenant records",
"summary": "Existing Customer Record",
"value": {
"customerId": "9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c",
"customerDisplayName": "Contoso - Testing",
"tenantList": {
"9f0a1b2c-3d4e-5f6a-7b8c-9d0e1f2a3b4c": "Contoso - Testing",
"2e3f4a5b-6c7d-8e9f-0a1b-2c3d4e5f6a7b": "Contoso - Testing - Staging 1",
"4b5c6d7e-8f9a-0b1c-2d3e-4f5a6b7c8d9e": "Contoso - Testing - Staging 2"
}
}
}
}
}
},
"description": "OK"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"500": {
"description": "Request has a failure that cannot be resolved and might require manual intervention or retry."
}
},
"summary": "Retrieves Details of One Customer Record",
"tags": [
"Customer Records"
]
}
},
"/API/Customer/Tenant/{tenantId}/": {
"patch": {
"description": "Update tenant record to either create association with provided customer value, or adjust human readable name, or both. This endpoint requires the `Customer.ReadWrite.All` scope (permission).",
"operationId": "/API/Customer/Tenant/:tenantId/Patch",
"parameters": [
{
"$ref": "#/components/parameters/tenantId"
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"customerId": {
"description": "Optional Object ID of the customer record to to use during update process.",
"example": "b2fd105a-2594-437e-b934-1a62a51c28b4",
"format": "uuid",
"maxLength": 36,
"minLength": 36,
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-5][0-9a-f]{3}-[089ab][0-9a-f]{3}-[0-9a-f]{12}$",
"type": "string"
},
"displayName": {
"description": "Optional string representing human readable name for the records.",
"example": "Contoso - New Tenant",
"type": "string"
}
}
},
"examples": {
"Example Request for Tenant Association": {
"description": "Sample payload requesting for the referenced tenant record to be associated with provided customer value",
"summary": "Create Customer Association for Tenant",
"value": {
"customerId": "6a7b8c9d-0e1f-2a3b-4c5d-6e7f8a9b0c1d"
}
},
"Example Request for Tenant Association and Name Update": {
"description": "Sample payload requesting to associate tenant record with the customer value and also update name on the tenant record",
"summary": "Update Tenant Record Name and Create Customer Association for Tenant",
"value": {
"customerId": "8f9a0b1c-2d3e-4f5a-6b7c-8d9e0a1b2c3d",
"displayName": "Contoso - R&D East"
}
},
"Example Request for Tenant Name Update": {
"description": "Sample payload requesting to update name on the tenant record",
"summary": "Update Tenant Record Name",
"value": {
"displayName": "Contoso - R&D North"
}
}
}
}
}
},
"responses": {
"204": {
"description": "Updated successfully"
},
"400": {
"$ref": "#/components/responses/400"
},
"401": {
"$ref": "#/components/responses/401"
},
"403": {
"$ref": "#/components/responses/403"
},
"404": {
"$ref": "#/components/responses/404"
},
"500": {
"description": "Request has a failure that cannot be resolved and might require manual intervention or retry."
}
},
"summary": "Update Tenant Record",
"tags": [
"Customer Records"
]
}
}
},
"security": [
Expand Down