eruvanos / openbrokerapi

A python package for the V2 CF Service Broker API
https://openbrokerapi.readthedocs.io/
MIT License
35 stars 19 forks source link

Question regarding the interface #70

Closed dcuenot closed 5 years ago

dcuenot commented 5 years ago

Hello,

When I have a look to the definition of the API in http://petstore.swagger.io/?url=https://raw.githubusercontent.com/openservicebrokerapi/servicebroker/v2.15/openapi.yaml, I saw that the body are not the same.

I will give a sample: For PUT /v2/service_instances/{instance_id}, in the specification, the body is:

{
  "service_id": "string",
  "plan_id": "string",
  "context": {},
  "parameters": {}
}

However when I use your package, for the same API, the body is :

{
    "service_id": "string",
    "plan_id": "string",
    "organization_guid": "string",
    "space_guid": "string"
}

Do you know where this difference is coming from?

Thanks for your help! Damien

eruvanos commented 5 years ago

Hi, regarding the spec: https://github.com/openservicebrokerapi/servicebroker/blob/v2.15/spec.md#provisioning

The attributes organization_guid, space_guidare required, the context object is optional, but should be included.

Looks like the the swagger doesn't fit to the spec. :/

dcuenot commented 5 years ago

Hi,

Thanks for your quick answer. However when I have a look in details in the SPEC, in says 2 things that seems to be inconsistent. image

The attributes organization_guid, space_guid are required, but they are deprecated... Is a way to remove the required part? or to define a default value?

Thanks 🙏

eruvanos commented 5 years ago

I will have a look, maybe it is possible to be a little bit more open, if the context contains these informations.

eruvanos commented 5 years ago

Ok, I will work over the weekend on a new version. Is it fine for you to require these information within the context information?

dcuenot commented 5 years ago

Yes, it's perfect :) Thanks for your help !

eruvanos commented 5 years ago

Hi short update, I finished a lot of open things to move to the API version 2.14 (2.15 follows).

After the release 4.0 I will include my local changes to support your use case in the version 4.1.

eruvanos commented 5 years ago

Fixed the issue with cedf87e67a54d413bf560efc5435c07989a5d0ce, thanks for waiting.

If you have further issues in mind, please give me a hint.