Sort endpoints within resources - SmartDocs

[#1]

Hi, I am trying to find a way to sort my SmartDocs endpoints within one resource in an order I define manually.

Is there any way to sort the endpoints? Can someone explain how to configure this?

[anilsr · Accepted solution]

Interesting Question @jan.willem.hennink ,

I assume, you are talking about SmartDocs listing page "model-name/apis" page just like below one,

Yes, It's possible to change sort order & thanks to Drupal (Apigee Developer Portal is powered by famous open source cms Drupal). By default, they are sorted by creation date. You can change the order based on manual set weight.

Please find steps below to achieve same,

• Download " Weight" 7.x contributed module from Drupal.org , Extract the zip file into sites/all/modules OR sites/all/modules/contrib folder.
• Enable the module by navigating to "admin/modules" page as Developer Portal Administrator. Click on Save Configuration.

• Navigate to "admin/structure/types/manage/smart_method/fields" , Add a new field called weight to the content type. See screenshot below for details. Click on Save -> Save Field Settings -> Choose Range as per need, I have selected 100 -> Save Settings.

• Edit the SmartDocs view which you would like to custom sort , Remove Default "Post Date" sort field & Add "SmartMethod Weight" field & save the view.

• Edit individual smartdocs method page to set weights to re-order them.

[#3]

This works great! Many thanks!

[anilsr]

Anytime @jan.willem.hennink , Glad issue is resolved 🙂

[kevinford]

Thanks Anil,

After enabling the Weight module...

• This doesn't appear in my admin menu
  • “admin/structure/types/manage/smart_method/fields”
• Do you mean
  • "admin/structure/taxonomy/smartdocs_models/fields?

Thanks

[chrisnovak]

I am able to navigate there as an admin by going to: Home » Administration » Structure » Content types » SmartDocs Method, see this screenshot:

[kevinford]

That looks right Chris. @Anil Sagar can you edit your answer to match the menu? Thanks

[veeraprasad]

Hi @Anil Sagar

I have tried to add weight field to the SmartDoc Method as mentioned by you. But when I import my swagger I see all APIs wight field has 0 only. Am I missing anything. Also wanted to confirm about order of APIs. Will it take exact order based on swagger apis under paths? Please answer my question.

Regards,

Veera

[#9]

Hi @Veera Prasad

When we configure new field in the smartdocs method for weight, there is an option for default value.

If you have set that to "0", in that case it will show 0 for all newly created smartdocs methods when we import the swagger.

As mentioned in the post at very end that,

"Edit individual smartdocs method page to set weights to re-order them."

We need to manually update the weight for each method that we write and also need to update the view which is used to sort the smartdocs methods when we render them.

Thanks,

Prathamesh

[sangameshhooli]

@Anil Sagar, @Prathamesh Kelaskar Is there any configuration at apigee. its should create smartdocs methods as per the order in swagger.yml so it will solve the issue without manually adding weights for each method after import of swagger.yml

[veeraprasad]

@SANGAMESH Hooli

I believe that we can utilize few existing SmartDoc APIs to enhance this feature. For example, to update weight field value, we can actually utilize hook_smartdocs_method_node_presave. I am in the process of finding the solution on capturing path order from swagger. I will keep you posted with solution.

Regards,
Veera