Add (or document how to) read schema properties

[tacman]

I'm using this library to read the description and example properties from the schema, but it seem that those properties are protected.

Perhaps I'm missing something, maybe it's there. If not, what do you think about a PR that basically adds getProperties to the schema that returns the now-protected properties?

[dearsina]

Weirdly enough, I'm here for the exact same reason. How do I read for instance all of the expected responses for a given path?

I got this far:

foreach($openapi->paths as $path => $definition) {
	foreach($definition->get->responses as $code => $response){
		var_dump($code);
		var_dump($response->get);
	}
}

But this will result in the below, and I'm a little stuck how to get for instance the schema other than using the getSerializableData() method, because that won't work when the value is a reference:

int(200)
object(cebe\openapi\spec\Response)#51 (10) {
  ["_properties":"cebe\openapi\SpecBaseObject":private]=>
  array(2) {
    ["description"]=>
    string(7) "Success"
    ["schema"]=>
    array(2) {
      ["type"]=>
      string(6) "string"
      ["example"]=>
      array(2) {
        ["Status"]=>
        string(7) "Success"
        ["Result"]=>
        array(1) {
          ["credits"]=>
          string(4) "5000"
        }
      }
    }
  }
 (...)
}

[cebe]

I'm using this library to read the description and example properties from the schema, but it seem that those properties are protected.

what makes you think that? what is the code you tried? if you have a Schema object, you can access the properties by $schema->example or $schema->description...

How do I read for instance all of the expected responses for a given path?

Exactly as you did. What is wrong with the result? you are getting the response code int(200) and the Response object for it.
$response->description should give you the description.

[tacman]

Again, maybe I'm not using the library right, could you add a snippet the the documentation?

        $openapi = Reader::readFromJsonFile($fn = $bag->get('kernel.project_dir') . '/openapi.json');
        foreach ($openapi->components->schemas as $schema) {
            dd($schema);
            // $properties = $schema->getProperties(); //<--   this does't work
        }

[dearsina]

@cebe I think the challenge is that at times, I won't know what property keys are available and it would be useful to have access to all of them instead of querying each one to see if they exist.

[SOHELAHMED7]

Added docs: #222