Uploaded image for project: 'BxMS Documentation'
  1. BxMS Documentation
  2. BXMSDOC-909

Development Guide "16.2.1. Managed Intelligent Process Server Environment" chapter is full of incorrect REST URLs

XMLWordPrintable

    • Sept Sprint
      • Use any of the incorrect URL listed above.
    • Documentation (Ref Guide, User Guide, etc.)

      • The "16.2.1. Managed Intelligent Process Server Environment" chapter [1] of BPMS 6.3 Development Guide is filled with incorrect REST API URLs.
      • This chapter basically covers how we can manage the kie-server and managed container endpoints via REST API. However, I found out that the URLs provided there are filled with incorrect URLs. Mostly it is caused at the "/server" URL which is now replaced by "/servers" .
      • I referred to the source code which serves as the REST endpoint implementation confirms that the endpoint URL which all have "/server" in it is incorrect. I am attaching it "RestSpecManagementServiceImpl.java" for your reference.
      • Here is a brief idea of which URLs are incorrect and what are the correct ones.
        Incorrect: [GET] /management/server/{id}
        Correct: [GET] /management/servers/{id}
        
        Incorrect: [PUT] /management/server/{id}
        Correct: [PUT] /management/servers/{id}
        
        Incorrect: [DELETE] /management/server/{id}
        Correct: [DELETE] /management/servers/{id}
        
        Incorrect: [GET] /management/server/{id}/containers
        Correct: [GET] /management/servers/{id}/containers
        
        Incorrect: [GET] /management/server/{id}/containers/{containerId}
        Correct: [GET] /management/servers/{id}/containers/{containerId}
        
        Incorrect: [PUT] /management/server/{id}/containers/{containerId}
        Correct: [PUT] /management/servers/{id}/containers/{containerId}
        
        Incorrect: [DELETE] /management/server/{id}/containers/{containerId}
        Correct: [DELETE] /management/servers/{id}/containers/{containerId}
        
        Incorrect: [POST] /management/server/{id}/containers/{containerId}/status/started
        Correct: [POST] /management/servers/{id}/containers/{containerId}/status/started
        
        Incorrect: [POST] /management/server/{id}/containers/{containerId}/status/stopped
        Correct: [POST] /management/servers/{id}/containers/{containerId}/status/stopped
        
      • This is hampering customers badly. As with each incorrect URL use they are getting 404 error messages like these.
        <html><head><title>JBWEB000065: HTTP Status 404 - RESTEASY001185: Could not find resource for relative : /controller/managemnt/server/local-server-123/containers/samplecontainer1/status/stopped of full path: http://localhost:8080/business-central/rest/controller/managemnt/server/local-server-123/containers/samplecontainer1/status/stopped</title><style>
        
      • Hence, I would honestly request you to treat this on priority and fix it ASAP, before more and more customers start facing this issue.

      [1] https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_BPM_Suite/6.3/html-single/Development_Guide/index.html#managed_intelligent_process_server_environment

              mczernek@redhat.com Marek Czernek (Inactive)
              rhn-support-mhussain Musharraf Hussain
              Votes:
              0 Vote for this issue
              Watchers:
              5 Start watching this issue

                Created:
                Updated:
                Resolved: