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.

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

Mismatch in the response of last operation for service bindings in openapi.yaml #738

Open
anoopjb opened this issue Apr 28, 2021 · 0 comments
Assignees

Comments

@anoopjb
Copy link

anoopjb commented Apr 28, 2021

What is the problem?
We have a mismatch in the response of last operation for service bindings in openapi.yaml from OSBApi specification v2.16.
The openapi.yaml reuses the LastOperationResource schema from the service instance. So the swagger shows response of GET request to ​/v2​/service_instances​/{instance_id}​/service_bindings​/{binding_id}​/last_operation as,

{
  "state": "in progress",
  "description": "string",
  "instance_usable": true,
  "update_repeatable": true
}

But the v2.16 specification advises having the response as,

{
  "state": "in progress",
  "description": "Creating binding (10% complete)."
}

The instance_usable and update_repeatable fields don't help binding anyway.

Who does this affect?
This might lead to a bit of confusion. Maybe the swagger-generated brokers might deviate from spec.

Do you have any proposed solutions?
An easy solution is to have a new ServiceBindingLastOperationResource schema.

    ServiceBindingLastOperationResource:
      type: object
      required:
        - state
      properties:
        state:
          type: string
          enum:
            - in progress
            - succeeded
            - failed
        description:
          type: string

Additional context
None

@Samze Samze self-assigned this May 11, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Inbox
Development

No branches or pull requests

3 participants