docs: align public API usage with owner contracts #6
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,7 +9,7 @@ info: | |
| name: GNU Affero General Public License v3.0 only | ||
| identifier: AGPL-3.0-only | ||
| servers: | ||
| - url: https://workbench.mavula.io | ||
| description: Workbench public endpoint | ||
| security: [{ bearerAuth: [] }] | ||
| tags: | ||
|
|
@@ -27,6 +27,9 @@ paths: | |
| description: Submit tenant-scoped payment work. The tenant is always derived from the access token. | ||
| tags: [Jobs] | ||
| x-mavula-permissions: [workbench.jobs.write] | ||
| parameters: | ||
| - { $ref: '#/components/parameters/IdempotencyKey' } | ||
| - { $ref: '#/components/parameters/CorrelationId' } | ||
| requestBody: | ||
| required: true | ||
| content: | ||
|
|
@@ -35,9 +38,7 @@ paths: | |
| examples: | ||
| payment_capture: | ||
| value: | ||
| type: PAYMENT_CAPTURE | ||
| payload: | ||
| idempotency_key: payment_capture_20260715_001 | ||
| correlation_id: checkout_20260715_001 | ||
|
|
@@ -52,6 +53,8 @@ paths: | |
| '400': { $ref: '#/components/responses/BadRequest' } | ||
| '401': { $ref: '#/components/responses/Unauthorized' } | ||
| '403': { $ref: '#/components/responses/Forbidden' } | ||
| '409': { $ref: '#/components/responses/Conflict' } | ||
| '503': { $ref: '#/components/responses/ServiceUnavailable' } | ||
| /api/jobs/{jobId}: | ||
| get: | ||
| operationId: getJob | ||
|
|
@@ -289,18 +292,40 @@ components: | |
| additionalProperties: false | ||
| properties: { limit: { type: integer, minimum: 1, maximum: 500 } } | ||
| CreateJob: | ||
| oneOf: | ||
| - $ref: '#/components/schemas/CreatePaymentCaptureJob' | ||
| - $ref: '#/components/schemas/CreatePaymentDisbursementJob' | ||
| - $ref: '#/components/schemas/CreatePaymentSettlementJob' | ||
| - $ref: '#/components/schemas/CreatePaymentReconciliationJob' | ||
| discriminator: { propertyName: type } | ||
|
There was a problem hiding this comment.
Sem Useful? React with 👍 / 👎. |
||
| CreatePaymentCaptureJob: | ||
| type: object | ||
| additionalProperties: false | ||
| required: [type, payload] | ||
| properties: | ||
| type: { type: string, const: PAYMENT_CAPTURE } | ||
| payload: { $ref: '#/components/schemas/PaymentStartPayload' } | ||
|
Comment on lines
303
to
+307
There was a problem hiding this comment.
Com este novo schema, cada variante de Useful? React with 👍 / 👎. |
||
| CreatePaymentDisbursementJob: | ||
| type: object | ||
| additionalProperties: false | ||
| required: [type, payload] | ||
| properties: | ||
| type: { type: string, const: PAYMENT_DISBURSEMENT } | ||
| payload: { $ref: '#/components/schemas/PaymentStartPayload' } | ||
| CreatePaymentSettlementJob: | ||
| type: object | ||
| additionalProperties: false | ||
| required: [type, payload] | ||
| properties: | ||
| type: { type: string, const: PAYMENT_SETTLEMENT } | ||
| payload: { $ref: '#/components/schemas/PaymentSettlementPayload' } | ||
| CreatePaymentReconciliationJob: | ||
| type: object | ||
| additionalProperties: false | ||
| required: [type, payload] | ||
| properties: | ||
| type: { type: string, const: PAYMENT_RECONCILIATION } | ||
| payload: { $ref: '#/components/schemas/PaymentReconciliationPayload' } | ||
| WorkerJob: | ||
| type: object | ||
| required: [id, queue, type, tenant_id, payload, status, attempts, max_attempts, created_at, updated_at] | ||
|
|
@@ -397,12 +422,19 @@ components: | |
| payload: { type: object, additionalProperties: true } | ||
| PlatformStatus: | ||
| type: object | ||
| additionalProperties: false | ||
| required: [status, service, version, environment, started_at, uptime_seconds, dependencies, worker, schedules, queues] | ||
| properties: | ||
| service: { type: string } | ||
| status: { type: string, enum: [ok, degraded, down] } | ||
| version: { type: string } | ||
| environment: { type: string } | ||
| started_at: { type: string, format: date-time } | ||
| uptime_seconds: { type: integer, minimum: 0 } | ||
| worker: { type: object, additionalProperties: true } | ||
| dependencies: { type: object, additionalProperties: true } | ||
| schedules: { type: array, items: { $ref: '#/components/schemas/ScheduledJob' } } | ||
| queues: { type: array, items: { $ref: '#/components/schemas/QueueStats' } } | ||
| HttpError: | ||
| type: object | ||
| required: [statusCode, message] | ||
|
|
@@ -432,3 +464,6 @@ components: | |
| Conflict: | ||
| description: Idempotency key, state, or delivery reference conflicts with existing state | ||
| content: { application/json: { schema: { $ref: '#/components/schemas/HttpError' } } } | ||
| ServiceUnavailable: | ||
| description: Durable receipt storage or queue execution is temporarily unavailable | ||
| content: { application/json: { schema: { $ref: '#/components/schemas/HttpError' } } } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ao adicionar
tenant_idaos schemas deauthorization_code(e também derefresh_token, linhas 231-234), o contrato público passa a aceitar um tenant informado pelo cliente em grants que já devem estar vinculados ao authorization code/refresh token. Em validadores/SDKs gerados a partir deste OpenAPI, isso viola o modelo documentado de tenant derivado da identidade e cria um caminho suportado para tentativas de troca de tenant; mantenha o seletor somente no grant de serviço ou rejeite-o nesses grants.Useful? React with 👍 / 👎.