Giter Club home page Giter Club logo

Comments (4)

dearsina avatar dearsina commented on July 29, 2024

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"
        }
      }
    }
  }
 (...)
}

from php-openapi.

cebe avatar cebe commented on July 29, 2024

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.

from php-openapi.

tacman avatar tacman commented on July 29, 2024

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
        }

image

from php-openapi.

dearsina avatar dearsina commented on July 29, 2024

@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.

from php-openapi.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.