Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[doc issue] Where can I find a complete API reference for routing in manifest.json? #124

Closed
ziyang-works opened this issue May 22, 2024 · 3 comments
Assignees
Labels
contribution Valuable Contribution follow-up-with/po Clarification with product owner needed. in-discussion This item is being discussed internally size/l Requires large effort to get changed. type/content-gaps Something essential is missing in the documentation. type/examples-samples Related to existing examples/samples, or request for new examples/samples. unresolved Valid feedback, but can't be resolved right now

Comments

@ziyang-works
Copy link

ziyang-works commented May 22, 2024

Issue description

I'm working on Step 30: Routing and Navigation of the Walkthrough Tutorial, and have some questions regarding the given manifes.json code:

{
  ...
  "sap.ui5": {
  ...
    "routing": {
      "config": {
        "routerClass": "sap.m.routing.Router",
        "type": "View",
        "viewType": "XML",
        "path": "ui5.walkthrough.view",
        "controlId": "app",
        "controlAggregation": "pages"
      },
      "routes": [
        {
          "pattern": "",
          "name": "overview",
          "target": "overview"
        },
        {
          "pattern": "detail",
          "name": "detail",
          "target": "detail"
        }
      ],
      "targets": {
        "overview": {
          "id": "overview",
          "name": "Overview"
        },
        "detail": {
          "id": "detail",
          "name": "Detail"
        }
      }
    }
  }
}

I want to find API reference documents that provides the complete list of possible properties in routing and their values but failed to do so.

For example, I want to find what config.controlId and config.controlAggregation mean, but in Routing Configuration page, they are under targets property instead of config, so the page does not provide all possible properties and values.

Besides, Is it possible to list all attributes in a table as something like follows so it's easier to find the property name I'm looking for? I find it difficult to locate a specific property on that Routing Configuration page. For now I have to read through unnecessary lines of text or search in the page to find the property name I need.

For example,
currently it's
image

It might be easier to navigate if it's something like:

config

Property name Description
routerClass some description
homeRoute some description

Feedback Type (Optional)

content structure

Page Title on SAP Help Portal (prefilled)

No response

Page URL on SAP Help Portal (prefilled)

No response

@KvM2
Copy link
Contributor

KvM2 commented May 22, 2024

Hi @ziyang-works . thanks for your contribution! We'll look into it and will get back to you.

@flovogt
Copy link

flovogt commented May 23, 2024

Hi @ziyang-works, thanks a lot for reporting this. I totally agree with you that this information is currently hard to get. You can basically use every property defined here https://ui5.sap.com/#/api/sap.ui.core.routing.$TargetSettings.

@KvM2 please get in touch with @stopcoder

@KlattG KlattG added contribution Valuable Contribution follow-up-with/dev Clarification with development needed. follow-up-with/po Clarification with product owner needed. in-discussion This item is being discussed internally size/l Requires large effort to get changed. type/content-gaps Something essential is missing in the documentation. type/examples-samples Related to existing examples/samples, or request for new examples/samples. labels May 28, 2024
@KlattG KlattG added unresolved Valid feedback, but can't be resolved right now and removed follow-up-with/dev Clarification with development needed. labels Oct 23, 2024
@KlattG
Copy link
Contributor

KlattG commented Oct 23, 2024

Hi @ziyang-works , we had a look at this issue but cannot provide a solution in the near future for capacity reasons, so we're closing it for now. If you’d like to check again with us at a later point, please comment below. We'll review and reopen the conversation if necessary. Until next time, thanks!

@KlattG KlattG closed this as completed Oct 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution Valuable Contribution follow-up-with/po Clarification with product owner needed. in-discussion This item is being discussed internally size/l Requires large effort to get changed. type/content-gaps Something essential is missing in the documentation. type/examples-samples Related to existing examples/samples, or request for new examples/samples. unresolved Valid feedback, but can't be resolved right now
Projects
None yet
Development

No branches or pull requests

4 participants