ovac / idoc Goto Github PK

Would be nice to be able to provide a custom documentation.blade file to be able to change the RedocPro.init() configuration

In no way I seem to be able to make idoc generate values for Properties and Required keywords in the schema of the @response content. Any indication how to do this?

Hi,

I would like to write a description to my endpoint group usig some like:

/**
 * Lorem ipsum dolor, sit amet consectetur adipisicing elit. 
 * 
 * @group Lorem
 * 
 */

Nowadays this description is not shown in documentation generated

executing the php artisan idoc:generate command this error occurred.
Laravel: 5.8.17

how to create and implementation of C# language in laravel...

In the documentation (https://github.com/ovac/idoc#grouping-endpoints), when clicking on the link http://marcelpociot.de/documentarian/installation/markdown_syntax you will redirected to a page which does not exist anymore.

Hi,

I'd like to use arrays or objects as @BodyParam but it not identify dot notation.

I mean something like:

 * @bodyParam  my_object object required.
 * Some object
 * 
 * @bodyParam  my_object.item string required 
 * Item in the object.

And

 * @bodyParam  my_array array 
 * Some array.
 * 
 * @bodyParam  my_array.* integer 
 *  Items in the array.

Even

 * @bodyParam  my_set array 
 * Some set
 * 
 * @bodyParam  my_set.*.item string
 * Object element within set

https://www.ovac4u.com/idoc

System info:

PHP: 8.0
Laravel: 8.x

I get some error:

ovac/idoc v1.3.0 requires illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0 -> found illuminate/routing[v5.5.0, ..., 5.8.x-dev, v6.0.0, ..., 6.x-dev, v7.0.0, ..., 7.x-dev] b
ut these were not loaded, likely because it conflicts with another require.

I keep getting "CSRF token mismatch." error even I try testing the api on idoc with Laravel Sanctum.

Good afternoon, first of all let me thank you for this amazing package!

I am trying to add the responses to the documentation, but once generated I only get the default 200 and nothing else.

/** * @response 200 { * "status": "success", * "message": "Your request was successfully created" * } * * @response 500 { * "status": "error", * "message": ["Custom error message"] * } */

Do I need to add/change anything?

Issue based on #19

Previous issue regarding this topic is closed as completed, but I can not find anywhere the example of how to use the said types of array or objects, because as it is decribed in the previous issue, it does not work.

The said types are really needed.

I have noticed, that Redoc can have an array containing object elements. Is there any way to that also? Or are any changes required for that to work?

Any of theses examples does not work.

 * @bodyParam  my_object object required.
 * Some object
 * 
 * @bodyParam  my_object.item string required 
 * Item in the object.

 * @bodyParam  my_array array 
 * Some array.
 * 
 * @bodyParam  my_array.* integer 
 *  Items in the array.

 * @bodyParam  my_set array 
 * Some set
 * 
 * @bodyParam  my_set.*.item string
 * Object element within set

Hi,

The environment vars for the API call works only to define specific vars, but if I want to change the whole APP_ENV environment it doesn't work, it still uses the default .env

How can I change the environment?

In idoc.php config file, I have this security settings:

    'security' => [
        'apiToken' => [
            'type' => 'apiKey',
            'name' => 'apiToken',
            'in' => 'header',
            'description' => 'Use `apiToken` in the requests.'
        ],
    ],

When I create the docs with php artisan idoc:generate the examples are created with Bearer JWT Token:

curl -X GET -G "http://localhost/api/myapiurl" \
    -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJod"

Edit

I tried to use the specification from here: https://spec.openapis.org/oas/v3.1.0#api-key-sample

The docs don't show any stated error responses. No matter if the 200 status code is supplied or not (or any positive response).

(#35)

Example:

/*
 * Title 
 *
 * @response {
 *   "status": 200
 * }
 *
 * @response 400 {
 *   "status": 400
 * }
 * @response 404 {
 *   "status": 404
 * }
 * 
 * / 

Outputs:

how to change custom header authenticate for idoc ?

Hi,

How can I document endpoints with uploading files?

After run: php artisan idoc:generate
Error

In IDocGeneratorCommand.php line 127:
                                                                      
Class C:32:"Opis\Closure\SerializableClosure":296:{ does not exist

Hi,

How can I disable middlewares to automatically generate all success responses without any problem of authentication, authorization, or others?

Redoc generated side menu disappears when scrolling down in latest version of Chrome and group expansion and collapse is inconsistent.

This bug was already reported in redoc Redocly/redoc#1167,

Looks like an deprecated CDN version bug

The "https://repo.packagist.org/packages.json" file could not be downloaded: php_network_getaddresses: getaddrinfo failed: No such host is known.
failed to open stream: php_network_getaddresses: getaddrinfo failed: No such host is known.
https://repo.packagist.org could not be fully loaded, package information was loaded from the local cache and may be out of date

Try to get the validation rules if a FormRequest instance is injected in the route.
Reference implementation

Enable set of tag groups according to redoc vendor extension x-tagGroups

Could you please update your great tool to make it support the latest Laravel version?

Hi. I tried to use this within my current project using Laravel 10. Running this command:

composer require ovac/idoc

Then this error appeared:

Info from https://repo.packagist.org: #StandWithUkraine
./composer.json has been updated
Running composer update ovac/idoc
Loading composer repositories with package information
Updating dependencies
Your requirements could not be resolved to an installable set of packages.

  Problem 1
    - ovac/idoc[v1.0.0, ..., v1.1.1] require illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* -> found illuminate/routing[v5.5.0, ..., v5.8.36] but these were not loaded, likely because it conflicts with another require.
    - ovac/idoc v1.2.0 requires illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 -> found illuminate/routing[v5.5.0, ..., v5.8.36, v6.0.0, ..., v6.20.44] but these were not loaded, likely because it conflicts with another require.
    - ovac/idoc v1.3.0 requires illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0 -> found illuminate/routing[v5.5.0, ..., v5.8.36, v6.0.0, ..., v6.20.44, v7.0.0, ..., v7.30.6] but these were not loaded, likely because it conflicts with another require.
    - ovac/idoc v1.4.0 requires illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0 || ^8.0 -> found illuminate/routing[v5.5.0, ..., v5.8.36, v6.0.0, ..., v6.20.44, v7.0.0, ..., v7.30.6, v8.0.0, ..., v8.83.27] but these were not loaded, likely because it conflicts with another require.
    - ovac/idoc 1.5.0 requires illuminate/routing 5.5.* || 5.6.* || 5.7.* || 5.8.* || ^6.0 || ^7.0 || ^8.0 || ^9.0 -> found illuminate/routing[v5.5.0, ..., v5.8.36, v6.0.0, ..., v6.20.44, v7.0.0, ..., v7.30.6, v8.0.0, ..., v8.83.27, v9.0.0, ..., v9.52.4] but these were not loaded, likely because it conflicts with another require.
    - Root composer.json requires ovac/idoc * -> satisfiable by ovac/idoc[v1.0.0, ..., 1.5.0].

You can also try re-running composer require with an explicit version constraint, e.g. "composer require ovac/idoc:*" to figure out if any version is installable, or "composer require ovac/idoc:^2.1" if you know which you need.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

May I know how to solve this?
Thanks!

/**

• Example API method with multiple responses.
• @response 200 {

• "success": true,
  

• "message": "Operation completed successfully."
  

• }
• @response 400 {

• "success": false,
  

• "message": "Bad request."
  

• }
• @response 401 {

• "success": false,
  

• "message": "Unauthorized."
  

• }
• @return \Illuminate\Http\Response
  */
  Here, there are four respone status code. But i when render code has only response status 200. Can you help me fix?